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

doc: improve assert docs by mscdex · Pull Request #7815 · nodejs/node · GitHub

/ node Public

doc: improve assert docs - #7815

Closed
mscdex wants to merge 3 commits into
nodejs:masterfrom
mscdex:doc-improve-assert
ConversationCommits (3)ChecksFiles changed
Closed

doc: improve assert docs#7815
mscdex wants to merge 3 commits into
nodejs:masterfrom
mscdex:doc-improve-assert

Conversation

mscdex commented Jul 21, 2016

Copy link
Copy Markdown
Contributor
Checklist
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)
  • doc
Description of change

Improve assert documentation by:

  • Reorganizing link references
  • Using consistent and concise language in function descriptions
  • Documenting function parameters and return types

mscdex added assert Issues and PRs related to the assert subsystem. doc Issues and PRs related to the documentations. labels Jul 21, 2016

mscdex commented Jul 21, 2016

Copy link
Copy Markdown
Contributor Author

/cc @nodejs/collaborators

mscdex changed the title Doc improve assert doc: improve assert docs Jul 21, 2016
mscdex force-pushed the doc-improve-assert branch from bbdbbf6 to b144415 Compare July 21, 2016 05:17

targos commented Jul 21, 2016

Copy link
Copy Markdown
Member

@nodejs/documentation

Trott reviewed Jul 21, 2016
View reviewed changes
Comment thread doc/api/assert.md Outdated

Trott Jul 21, 2016

Copy link
Copy Markdown
Member

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

Nit: no scare quotes around strict equal

mscdex force-pushed the doc-improve-assert branch from b144415 to d111e9c Compare July 21, 2016 05:57
doc: improve assert function descriptions
9921539 
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 July 21, 2016 06:00
thefourtheye reviewed Jul 21, 2016
View reviewed changes
Comment thread doc/api/assert.md

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

thefourtheye Jul 21, 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

Would Any be better instead of mixed?

mscdex Jul 21, 2016 •
edited
Loading

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

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

targos Jul 21, 2016

Copy link
Copy Markdown
Member

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

Closure and JSDoc use {*}

rvagg force-pushed the master branch 2 times, most recently from c133999 to 83c7a88 Compare October 18, 2016 17:02
joyeecheung mentioned this pull request Dec 15, 2016
Closed
3 tasks

Trott commented Feb 24, 2017

Copy link
Copy Markdown
Member

@mscdex Are you up for rebasing this?

Trott commented Mar 22, 2017

Copy link
Copy Markdown
Member

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.

Trott closed this Mar 22, 2017
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

jasnell jasnell approved these changes

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.

5 participants

Back | FazBrowse Home | New Git URL