Rich Trott
b607366a1c
doc: add information about Assert behavior and maintenance
...
Assert is now locked. Userland alternatives should be used. Assert is
for testing Node.js itself.
Document potentially surprising use of enumerable properties only in
deep equality assertions.
Ref: https://github.com/nodejs/node/pull/3124
Ref: https://github.com/nodejs/node/issues/3122
PR-URL: https://github.com/nodejs/node/pull/3330
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Fedor Indutny <fedor@indutny.com >
Reviewed-By: Rod Vagg <rod@vagg.org >
2015-10-20 23:13:58 -04:00
David Boivin
8e213096df
doc: update the assert module summary
...
The current wording "This module is used for writing unit tests for your
applications, you can access it with require('assert')." implies that
this module should only be used in development while unit testing.
The article "Error Handling in Node.js" by Joyent
(https://www.joyent.com/developers/node/design/errors ) uses the assert
module in an efficient way to validate required function arguments.
PR-URL: https://github.com/nodejs/node/pull/2799
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com >
Reviewed-By: Rich Trott <rtrott@gmail.com >
Reviewed-By: Roman Reiss <me@silverwind.io >
2015-10-11 19:24:39 +02:00
Fabio Oliveira
79ebeabd08
docs: Clarify assert.doesNotThrow behavior
...
The documentation for assert.doesNotThrow now reflects all the inputs
the function accepts, as well as the errors thrown for each combination
of parameter types.
PR-URL: https://github.com/nodejs/node/pull/2807
Reviewed-By: Rich Trott <rtrott@gmail.com >
2015-09-23 15:07:59 -07:00
Rich Trott
4fb4c14b61
doc: clarify description of assert.ifError()
...
This fixes a few typographical errors (comma splices and the like) and
clarifies the description of assert.ifError(). It also standardizes the
document on "inequality" rather than having both "inequality" and "non-
equality".
PR-URL: https://github.com/nodejs/node/pull/2941
Reviewed-By: Michaël Zasso <mic.besace@gmail.com >
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com >
2015-09-18 23:46:36 -07:00
Rich Trott
8f87169805
doc: fix comma splice in Assertion Testing doc
...
This fixes a minor typographical error in the Assertion Testing doc.
PR-URL: https://github.com/nodejs/node/pull/2728
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Michaël Zasso <mic.besace@gmail.com >
Reviewed-By: Johan Bergström <bugs@bergstroem.nu >
2015-09-08 14:42:27 -07:00
Chris Dickinson
cf0306cd71
doc: update stability index
...
This simplifies the stability index to 4 levels:
0 - deprecated
1 - experimental / feature-flagged
2 - stable
3 - locked
Domains has been downgraded to deprecated, assert has been
downgraded to stable. Timers and Module remain locked. All
other APIs are now stable.
PR-URL: https://github.com/iojs/io.js/pull/943
Fixes: https://github.com/iojs/io.js/issues/930
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com >
Reviewed-By: Vladimir Kurchatkin <vladimir.kurchatkin@gmail.com >
2015-02-27 14:23:01 -08:00
Andrei Sedoi
8c1df7a8a8
doc: use correct signature for assert()
...
The message argument is optional for both assert() and
assert.ok(). This commit makes message optional for assert().
PR-URL: https://github.com/joyent/node/pull/9003
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Trevor Norris <trev.norris@gmail.com >
2015-02-13 13:37:24 -05:00
Vladimir Kurchatkin
3f473ef141
assert: introduce deepStrictEqual
...
`deepStrictEqual` works the same way as `strictEqual`, but
uses `===` to compare primitives and requires prototypes of
equal objects to be the same object.
Fixes: https://github.com/joyent/node/issues/7161
Fixes: https://github.com/iojs/io.js/issues/620
PR-URL: https://github.com/iojs/io.js/pull/639
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com >
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl >
Reviewed-by: Rod Vagg <rod@vagg.org >
2015-02-09 14:14:20 +03:00
Trevor Norris
f2a78de6ec
doc: fix optional parameter parsing
...
The parameter parser specifically looked for the old bracket syntax.
This generated a lot of warnings when building the docs. Those warnings
have been fixed by changing the parsing logic.
Signed-off-by: Trevor Norris <trev.norris@gmail.com >
2014-09-29 16:32:34 -07:00
Trevor Norris
51b6b6844e
doc: fix brackets for optional parameters
...
Documentation incorrectly used bracket notation for optional parameters.
This caused inconsistencies in usage because of examples like the
following:
fs.write(fd, data[, position[, encoding]], callback)
This simply fixes all uses of bracket notation in documentation.
Signed-off-by: Trevor Norris <trev.norris@gmail.com >
Reviewed-by: Fedor Indutny <fedor@indutny.com >
2014-09-25 11:26:15 -07:00
Nicolas Talle
1efe6837b2
doc: update assert.markdown
...
Update assert.throws() and assert.doesNotThrow() docs
2014-02-23 18:09:26 +04:00
Ben Noordhuis
e4cef1a083
doc: update assert.doesNotThrow() docs
...
It takes an optional "expected exception" argument that is not used meaningfully
but is nevertheless documented. Undocument it, it confuses casual readers of the
documentation.
Fixes #3935 .
2012-08-29 02:36:22 +02:00
Nao Iizuka
f8ce384446
docs: correct the description of assert.ok()
2012-03-12 02:27:55 +01:00
isaacs
2d44dcc8be
doc: Add stability indicators to documentation
2012-03-03 17:03:52 -08:00
isaacs
d383954ffe
doc refactor: assert
2012-02-29 15:23:00 -08:00
Maciej Małecki
f4f037aa64
docs: Update assert module docs
2011-10-02 02:25:52 +02:00
Brian White
d22259426c
Fix incorrect documentation for assert.fail()
...
Fixes #1100 .
2011-05-24 10:44:14 -07:00
Oleg Slobodskoi
23cf938e4f
fix assert.throws
2010-12-21 12:41:57 -08:00
Oleg Slobodskoi
c5c1dc5dda
docs for assert.throws
2010-12-02 11:07:47 -08:00
Silas Sewell
11b2ee7632
Various doc tweaks (2-spaces vs tabs, EOL-whitespace, repl prompt, "world" vs "World", etc...)
2010-11-21 14:33:09 -08:00
Oleg Efimov
8b980d729c
Fix line wrapping in docs. Add tics for constants in docs text.
2010-11-18 15:41:15 -08:00
Micheil Smith
e190c9616e
Splitting documentation
2010-10-28 14:59:15 -07:00
Rich Trott