doc: improve assert docs #7815
doc: improve assert docs #7815
Conversation
mscdex
added
assert
|
/cc @nodejs/collaborators |
mscdex
force-pushed
the
doc-improve-assert
branch
from
bbdbbf6
to
b144415
Compare
|
@nodejs/documentation |
doc/api/assert.md
Outdated
| 'strict equal' operator (`===`). If `actual` and `expected` are not equal, then | ||
| an `AssertionError` exception is thrown. | ||
|
|
||
| Object comparisons include a 'strict equal' check of their prototypes. |
There was a problem hiding this comment.
Nit: no scare quotes around strict equal
mscdex
force-pushed
the
doc-improve-assert
branch
from
b144415
to
d111e9c
Compare
This commit uses more consistent language in function descriptions and adds function parameter and return type information.
mscdex
force-pushed
the
doc-improve-assert
branch
from
d111e9c
to
9921539
Compare
|
|
||
| ## assert.deepEqual(actual, expected[, message]) | ||
| <!-- YAML | ||
| added: v0.1.21 | ||
| --> | ||
|
|
||
| Tests for deep equality between the `actual` and `expected` parameters. | ||
| Primitive values are compared with the equal comparison operator ( `==` ). | ||
| * `actual` {mixed} A value to check |
There was a problem hiding this comment.
Would Any be better instead of mixed?
There was a problem hiding this comment.
I used mixed because that is what I'm used to seeing in the online PHP documentation when they refer to a parameter that can be any or many different types. I figured other people coming from PHP might find that term more familiar than something else. shrug
rvagg
force-pushed
the
master
branch
2 times, most recently
from
c133999
to
83c7a88
Compare
|
@mscdex Are you up for rebasing this? |
|
Looks like most of these improvements or variations on them have already landed via other PRs. I'm going to go ahead and close this but absolutely feel free to re-open it if it's something you plan on rebasing and continuing to work on. |
Checklist
Affected core subsystem(s)
Description of change
Improve
assertdocumentation by: