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.

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: 'assert' description contains backwards actual/expected #3530

Closed
birnam opened this issue Oct 26, 2015 · 3 comments
Closed

doc: 'assert' description contains backwards actual/expected #3530

birnam opened this issue Oct 26, 2015 · 3 comments
Labels
assert Issues and PRs related to the assert subsystem. doc Issues and PRs related to the documentations.

Comments

@birnam
Copy link
Contributor

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).
@Fishrock123 Fishrock123 added the doc Issues and PRs related to the documentations. label Oct 26, 2015
@Fishrock123
Copy link
Contributor

@birnam mind to make a Pull Request for it? I'd gladly review it!

@birnam
Copy link
Contributor Author

birnam commented Oct 26, 2015

Sure -- PR: #3533

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

This was landed in 471aa5a

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
assert Issues and PRs related to the assert subsystem. doc Issues and PRs related to the documentations.
Projects
None yet
Development

No branches or pull requests

4 participants