jiangcuo/node
1
0
Fork 0
mirror of https://github.com/nodejs/node.git synced 2025-05-02 03:31:35 +00:00
Code Issues Actions 26 Packages Projects Releases Wiki Activity
959c425a19
node/doc/api
History
Rich Trott 959c425a19 doc: make error descriptions more concise 
Remove the practice of starting most error descriptions with "Used when"
or wordier variations.

Change errors of the form:

> Used when the type of an asynchronous resource is invalid.

...to:

> The type of an asynchronous resource was invalid.

Change errors of the form:

> The `'ERR_INVALID_CURSOR_POS'` is thrown specifically when a cursor on
> a given stream is attempted to move to a specified row without a
> specified column.

...to:

> A cursor on a given stream cannot be moved to a specified row without
> a specified column.

PR-URL: https://github.com/nodejs/node/pull/16954
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
2017-11-17 09:57:00 -08:00
..
_toc.md doc: add ESM doc to _toc.md and all.md 2017-09-08 06:34:47 +03:00
addons.md build: make test-doc and lint addon docs 2017-10-30 17:28:07 +08:00
all.md doc: add ESM doc to _toc.md and all.md 2017-09-08 06:34:47 +03:00
assert.md doc: fix typo in assert.md 2017-11-08 02:30:42 +02:00
async_hooks.md doc: correct the wrong added meta data 2017-11-16 15:30:33 -05:00
buffer.md doc: replace methods used in the example code 2017-10-23 22:55:45 +03:00
child_process.md doc: update subprocess.killed 2017-11-07 15:35:31 -05:00
cli.md cli: add --stack-trace-limit to NODE_OPTIONS 2017-11-03 01:04:07 +01:00
cluster.md doc: make default values and periods consistent 2017-10-30 11:08:47 +01:00
console.md doc: fix json generator warnings 2017-11-07 09:40:04 +01:00
crypto.md doc : mention constant-time in crypto doc 2017-11-02 18:38:17 +08:00
debugger.md test: remove obsolete debugger tests 2017-09-13 17:58:38 -03:00
deprecations.md util: runtime deprecation for custom .inspect() 2017-11-16 22:00:39 -08:00
dgram.md doc: correct the spelling of omitting in dgram.md 2017-11-11 10:19:01 +01:00
dns.md doc: make default values and periods consistent 2017-10-30 11:08:47 +01:00
documentation.md doc: add links to alternative versions of doc 2017-08-28 11:17:08 +02:00
domain.md 2017-10-24, Node.js Version 8.8.0 (Current) 2017-10-24 17:50:44 -04:00
errors.md doc: make error descriptions more concise 2017-11-17 09:57:00 -08:00
esm.md doc: remove loader hooks from unsupported features 2017-10-25 10:57:51 -07:00
events.md doc: correct effects to affects 2017-11-06 03:51:53 -08:00
fs.md doc: correct the wrong added meta data 2017-11-16 15:30:33 -05:00
globals.md doc: add links to alternative versions of doc 2017-08-28 11:17:08 +02:00
http2.md doc: fix typo in http2 doc 2017-11-13 11:30:48 -08:00
http.md doc: correct the wrong added meta data 2017-11-16 15:30:33 -05:00
https.md doc: add clientCertEngine to docs 2017-11-11 13:35:23 -08:00
index.md doc: git mv to .md 2016-04-20 16:34:27 -07:00
inspector.md doc: update test/inspector reference 2017-10-18 11:17:57 -07:00
intl.md doc: environmental->environment & NodeJS->Node.js 2017-08-24 15:17:29 -07:00
modules.md 2017-10-31, Version 8.9.0 'Carbon' (LTS) Release 2017-10-31 18:29:48 +00:00
n-api.md doc: document common pattern for instanceof checks 2017-11-17 10:01:11 -05:00
net.md doc: make default values and periods consistent 2017-10-30 11:08:47 +01:00
os.md doc: make default values and periods consistent 2017-10-30 11:08:47 +01:00
path.md 2017-10-31, Version 9.0.0 (Current) 2017-10-31 12:59:12 -07:00
perf_hooks.md perf_hooks: remove docs for unimplemented API 2017-09-29 09:38:48 -07:00
process.md 2017-11-14, Version 9.2.0 (Current) 2017-11-14 17:08:15 -06:00
punycode.md doc: add links to alternative versions of doc 2017-08-28 11:17:08 +02:00
querystring.md doc: add links to alternative versions of doc 2017-08-28 11:17:08 +02:00
readline.md doc: make default values and periods consistent 2017-10-30 11:08:47 +01:00
repl.md 2017-10-31, Version 9.0.0 (Current) 2017-10-31 12:59:12 -07:00
stream.md stream: remove usage of *State.highWaterMark 2017-11-15 14:30:39 +01:00
string_decoder.md doc: add links to alternative versions of doc 2017-08-28 11:17:08 +02:00
synopsis.md doc: add links to alternative versions of doc 2017-08-28 11:17:08 +02:00
timers.md doc: add links to alternative versions of doc 2017-08-28 11:17:08 +02:00
tls.md doc: add clientCertEngine to docs 2017-11-11 13:35:23 -08:00
tracing.md async_hooks: add trace events to async_hooks 2017-11-16 11:46:54 +01:00
tty.md doc: add isTTY property documentation 2017-11-07 10:08:16 +00:00
url.md doc: add links to alternative versions of doc 2017-08-28 11:17:08 +02:00
util.md util: runtime deprecation for custom .inspect() 2017-11-16 22:00:39 -08:00
v8.md v8: migrate setFlagsFromString to internal/errors 2017-10-29 17:04:27 -07:00
vm.md doc: improve documentation for the vm module 2017-11-09 21:29:55 +01:00
zlib.md doc: correct the wrong added meta data 2017-11-16 15:30:33 -05:00