-
Notifications
You must be signed in to change notification settings - Fork 30k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
doc: mention prototype check in deepStrictEqual() #5367
Conversation
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=@nodejs/documentation |
LGTM |
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 |
What about this?
|
That might still imply that their prototypes are checked and are expected to be equal (is that the case?) - what about:
|
It's actually a strict comparison of the prototypes. https://github.com/nodejs/node/blob/master/lib/assert.js#L199 |
@cjihrig Oh, in that case my bad - LGTM |
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
object prototypes are included in the comparison.
seems a little vague to me.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
See proposed change in the main thread.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
it would have been better if we could somehow say that prototypes should be the same. But yeah the proposed change also is okay.
LGTM |
Thanks for the reviews. Landed in 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