lukechilds/node - node - Gitea: Git with a cup of tea

Commit Graph

Author	SHA1	Message	Date
daveboivin	d384bf8f84	Update assert.markdown 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/joyent/node/pull/25811 Reviewed-By: James M Snell <jasnell@gmail.com>	10 years ago
Andrei Sedoi	430096a90f	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>	10 years ago
Andrei Sedoi	e45c52c573	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>	10 years ago
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>	11 years ago
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>	11 years ago
Nicolas Talle	1efe6837b2	doc: update assert.markdown Update assert.throws() and assert.doesNotThrow() docs	11 years ago
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.	13 years ago
Nao Iizuka	f8ce384446	docs: correct the description of assert.ok()	13 years ago
isaacs	2d44dcc8be	doc: Add stability indicators to documentation	13 years ago
isaacs	d383954ffe	doc refactor: assert	13 years ago
isaacs	97ee38707b	doc refactor: assert	13 years ago
Maciej Małecki	f4f037aa64	docs: Update `assert` module docs	14 years ago
Brian White	d22259426c	Fix incorrect documentation for assert.fail() Fixes #1100.	14 years ago
Oleg Slobodskoi	23cf938e4f	fix assert.throws	14 years ago
Oleg Slobodskoi	c5c1dc5dda	docs for assert.throws	14 years ago
Silas Sewell	11b2ee7632	Various doc tweaks (2-spaces vs tabs, EOL-whitespace, repl prompt, "world" vs "World", etc...)	15 years ago
Oleg Efimov	8b980d729c	Fix line wrapping in docs. Add tics for constants in docs text.	15 years ago
Micheil Smith	e190c9616e	Splitting documentation	15 years ago

16 Commits (810fb211a734edd2ed2739cec03cd8d5a2fd956f)