FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

doc: mention prototype check in deepStrictEqual() by cjihrig · Pull Request #5367 · nodejs/node · GitHub

/ node Public

doc: mention prototype check in deepStrictEqual() - #5367

Closed
cjihrig wants to merge 1 commit into
nodejs:masterfrom
cjihrig:5365
ConversationCommits (1)ChecksFiles changed
Closed

doc: mention prototype check in deepStrictEqual()#5367
cjihrig wants to merge 1 commit into
nodejs:masterfrom
cjihrig:5365

Conversation

cjihrig commented Feb 22, 2016

Copy link
Copy Markdown
Contributor

The docs for assert.deepStrictEqual() do not currently mention that prototypes are compared for objects. This commit adds that information to the documentation.

Fixes: #5365

doc: mention prototype check in deepStrictEqual()
3b21bbb 
The docs for assert.deepStrictEqual() do not currently mention
that prototypes are compared for objects. This commit adds that
information to the documentation.

Fixes: nodejs#5365
r-52 added assert Issues and PRs related to the assert subsystem. doc Issues and PRs related to the documentations. lts-watch-v4.x labels Feb 22, 2016

cjihrig commented Feb 23, 2016

Copy link
Copy Markdown
Contributor Author

R=@nodejs/documentation

eljefedelrodeodeljefe commented Feb 23, 2016

Copy link
Copy Markdown
Contributor

LGTM

benjamingr commented Feb 23, 2016

Copy link
Copy Markdown
Member

I'm not sure I would understand what "object prototypes are included in the comparison" means - it might imply they need to have the same __proto__.

cjihrig commented Feb 23, 2016

Copy link
Copy Markdown
Contributor Author

What about this?

Generally identical to `assert.deepEqual()` with two exceptions. First, primitive values
are compared using the strict equality operator ( `===` ). Second, object comparisons
include a strict equality check of their prototypes.

benjamingr commented Feb 23, 2016

Copy link
Copy Markdown
Member

That might still imply that their prototypes are checked and are expected to be equal (is that the case?) - what about:

Generally identical to assert.deepEqual() with two exceptions. First, primitive values
are compared using the strict equality operator ( === ). Second, object comparisons
include a strict equality check of properties on their prototypes.

cjihrig commented Feb 23, 2016

Copy link
Copy Markdown
Contributor Author

It's actually a strict comparison of the prototypes. https://github.com/nodejs/node/blob/master/lib/assert.js#L199

benjamingr commented Feb 23, 2016

Copy link
Copy Markdown
Member

@cjihrig Oh, in that case my bad - LGTM

thefourtheye reviewed Feb 23, 2016
View reviewed changes
Comment thread doc/api/assert.markdown
values are compared using the strict equality operator ( `===` ).
Generally identical to [`assert.deepEqual()`][] with the exceptions that
primitive values are compared using the strict equality operator ( `===` ), and
object prototypes are included in the comparison.

thefourtheye Feb 23, 2016

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

object prototypes are included in the comparison.

seems a little vague to me.

cjihrig Feb 23, 2016

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

See proposed change in the main thread.

thefourtheye Feb 23, 2016

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

it would have been better if we could somehow say that prototypes should be the same. But yeah the proposed change also is okay.

thefourtheye commented Feb 23, 2016

Copy link
Copy Markdown
Contributor

LGTM

cjihrig added a commit that referenced this pull request Feb 23, 2016
doc: mention prototype check in deepStrictEqual()
10f55b0 
The docs for assert.deepStrictEqual() do not currently mention
that prototypes are compared for objects. This commit adds that
information to the documentation.

Fixes: #5365
PR-URL: #5367
Reviewed-By: Robert Lindstädt <robert.lindstaedt@gmail.com>
Reviewed-By: Benjamin Gruenbaum <inglor@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>

cjihrig commented Feb 23, 2016

Copy link
Copy Markdown
Contributor Author

Thanks for the reviews. Landed in 10f55b0.

cjihrig closed this Feb 23, 2016
cjihrig deleted the 5365 branch February 23, 2016 14:21
rvagg pushed a commit that referenced this pull request Feb 27, 2016
doc: mention prototype check in deepStrictEqual()
8c469fa 
The docs for assert.deepStrictEqual() do not currently mention
that prototypes are compared for objects. This commit adds that
information to the documentation.

Fixes: #5365
PR-URL: #5367
Reviewed-By: Robert Lindstädt <robert.lindstaedt@gmail.com>
Reviewed-By: Benjamin Gruenbaum <inglor@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
rvagg pushed a commit that referenced this pull request Feb 27, 2016
doc: mention prototype check in deepStrictEqual()
2b00c31 
The docs for assert.deepStrictEqual() do not currently mention
that prototypes are compared for objects. This commit adds that
information to the documentation.

Fixes: #5365
PR-URL: #5367
Reviewed-By: Robert Lindstädt <robert.lindstaedt@gmail.com>
Reviewed-By: Benjamin Gruenbaum <inglor@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Fishrock123 mentioned this pull request Mar 1, 2016
Merged
5 tasks
MylesBorins pushed a commit that referenced this pull request Mar 1, 2016
doc: mention prototype check in deepStrictEqual()
5a618e3 
The docs for assert.deepStrictEqual() do not currently mention
that prototypes are compared for objects. This commit adds that
information to the documentation.

Fixes: #5365
PR-URL: #5367
Reviewed-By: Robert Lindstädt <robert.lindstaedt@gmail.com>
Reviewed-By: Benjamin Gruenbaum <inglor@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
MylesBorins pushed a commit that referenced this pull request Mar 1, 2016
doc: mention prototype check in deepStrictEqual()
7070ad0 
The docs for assert.deepStrictEqual() do not currently mention
that prototypes are compared for objects. This commit adds that
information to the documentation.

Fixes: #5365
PR-URL: #5367
Reviewed-By: Robert Lindstädt <robert.lindstaedt@gmail.com>
Reviewed-By: Benjamin Gruenbaum <inglor@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
MylesBorins pushed a commit that referenced this pull request Mar 2, 2016
doc: mention prototype check in deepStrictEqual()
dc3f5fa 
The docs for assert.deepStrictEqual() do not currently mention
that prototypes are compared for objects. This commit adds that
information to the documentation.

Fixes: #5365
PR-URL: #5367
Reviewed-By: Robert Lindstädt <robert.lindstaedt@gmail.com>
Reviewed-By: Benjamin Gruenbaum <inglor@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

assert Issues and PRs related to the assert subsystem. doc Issues and PRs related to the documentations.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

Back | FazBrowse Home | New Git URL