Skip to content
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.

Sign up for GitHub

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

Jump to bottom

doc: issue-3530 assert.markdown updated #3533

Closed
wants to merge 1 commit into from
Closed

doc: issue-3530 assert.markdown updated #3533

wants to merge 1 commit into from

Conversation

birnam
Copy link
Contributor

@birnam birnam commented Oct 26, 2015

Documentation for assert describes:

assert(value[, message]), assert.ok(value[, message])
Tests if value is truthy. It is equivalent to assert.equal(true, !!value, message).

But assert.equal parameters are actual value first, then expected value. The documentation should read:

assert(value[, message]), assert.ok(value[, message])#
Tests if value is truthy. It is equivalent to assert.equal(!!value, true, message).

@birnam birnam mentioned this pull request Oct 26, 2015
Closed
@Fishrock123
Copy link
Contributor

@birnam could you prefix the commit message with doc: and make sure it is no longer than 50 characters?

@Fishrock123 Fishrock123 added the doc Issues and PRs related to the documentations. label Oct 26, 2015
@birnam birnam changed the title issue-3530 assert.markdown updated to correct 'equivalent' syntax of assert() doc: issue-3530 assert.markdown updated Oct 26, 2015
@birnam birnam force-pushed the issue-3530-assert-doc-correction branch from 6185451 to 06162e0 Compare October 26, 2015 18:30
@birnam
Copy link
Contributor Author

birnam commented Oct 26, 2015

commit is updated @Fishrock123

@mscdex mscdex added the assert Issues and PRs related to the assert subsystem. label Oct 26, 2015
@evanlucas
Copy link
Contributor

LGTM

1 similar comment
@thefourtheye
Copy link
Contributor

LGTM

jasnell pushed a commit that referenced this pull request Nov 3, 2015
@birnam @jasnell
doc:fix function param order in assert doc
471aa5a 
PR-URL: #3533
Reviewed-By: Evan Lucas <evanlucas@me.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
@jasnell
Copy link
Member

jasnell commented Nov 3, 2015

Landed in 471aa5a

@jasnell jasnell closed this Nov 3, 2015
@Fishrock123 Fishrock123 mentioned this pull request Nov 6, 2015
Closed
rvagg pushed a commit that referenced this pull request Nov 7, 2015
@birnam @rvagg
doc:fix function param order in assert doc
325c4c7 
PR-URL: #3533
Reviewed-By: Evan Lucas <evanlucas@me.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
@Fishrock123 Fishrock123 mentioned this pull request Nov 11, 2015
Merged
MylesBorins pushed a commit that referenced this pull request Nov 16, 2015
@birnam
doc:fix function param order in assert doc
dfc2707 
PR-URL: #3533
Reviewed-By: Evan Lucas <evanlucas@me.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
@MylesBorins
Copy link
Contributor

landed in lts-v4.x-staging as dfc2707

@rvagg rvagg mentioned this pull request Nov 17, 2015
Closed
rvagg pushed a commit that referenced this pull request Dec 4, 2015
@birnam @rvagg
doc:fix function param order in assert doc
688ad38 
PR-URL: #3533
Reviewed-By: Evan Lucas <evanlucas@me.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
@jasnell jasnell mentioned this pull request Dec 17, 2015
Closed
jasnell pushed a commit that referenced this pull request Dec 17, 2015
@birnam @jasnell
doc:fix function param order in assert doc
cf4b65c 
PR-URL: #3533
Reviewed-By: Evan Lucas <evanlucas@me.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
jasnell pushed a commit that referenced this pull request Dec 23, 2015
@birnam @jasnell
doc:fix function param order in assert doc
bb4431a 
PR-URL: #3533
Reviewed-By: Evan Lucas <evanlucas@me.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
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.
7 participants
@birnam @Fishrock123 @evanlucas @thefourtheye @jasnell @MylesBorins @mscdex