Skip to content

doc: issue-3530 assert.markdown updated - #3533

Closed
birnam wants to merge 1 commit into
nodejs:masterfrom
birnam:issue-3530-assert-doc-correction
Closed

doc: issue-3530 assert.markdown updated#3533
birnam wants to merge 1 commit into
nodejs:masterfrom
birnam:issue-3530-assert-doc-correction

Conversation

@birnam

@birnambirnam commented Oct 26, 2015

Copy link
Copy Markdown
Contributor

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).

@birnambirnam mentioned this pull request Oct 26, 2015
Closed
@Fishrock123

Fishrock123 commented Oct 26, 2015

Copy link
Copy Markdown
Contributor

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

@Fishrock123Fishrock123 added the doc Issues and PRs related to the documentations. label Oct 26, 2015
@birnambirnam changed the title issue-3530 assert.markdown updated to correct 'equivalent' syntax of assert()doc: issue-3530 assert.markdown updatedOct 26, 2015
@birnam
birnamforce-pushed the issue-3530-assert-doc-correction branch from 6185451 to 06162e0CompareOctober 26, 2015 18:30
@birnam

birnam commented Oct 26, 2015

Copy link
Copy Markdown
ContributorAuthor

commit is updated @Fishrock123

@mscdexmscdex added the assert Issues and PRs related to the assert subsystem. label Oct 26, 2015
@evanlucas

evanlucas commented Oct 27, 2015

Copy link
Copy Markdown
Contributor

LGTM

1 similar comment
@thefourtheye

thefourtheye commented Oct 27, 2015

Copy link
Copy Markdown
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

jasnell commented Nov 3, 2015

Copy link
Copy Markdown
Member

Landed in 471aa5a

@jasnelljasnell closed this Nov 3, 2015
@Fishrock123Fishrock123 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>
@Fishrock123Fishrock123 mentioned this pull request Nov 11, 2015
Merged
MylesBorins pushed a commit that referenced this pull request Nov 16, 2015
@birnamMyles Borins
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

MylesBorins commented Nov 16, 2015

Copy link
Copy Markdown
Contributor

landed in lts-v4.x-staging as dfc2707

@rvaggrvagg 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>
@jasnelljasnell 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 freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

assertIssues and PRs related to the assert subsystem.docIssues 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