0
0
mirror of https://github.com/nodejs/node.git synced 2024-12-01 16:10:02 +01:00
nodejs/doc/api
Sam Roberts 2e16037201 doc: cluster documentation cleanup and corrections
- fixed some incomprehensible wording ("event assigned to..."?)
- removed undocumented and unnecessary process properties from example
- corrected the docs on the default for the exec setting
- described when workers are removed from cluster.workers
- described addressType, which was documented as existing, but not what
  values it might have
- spell out more clearly the limitations of setupMaster
- describe disconnect in sufficient detail that why a child does or does
  not exit can be understood
- clarify which cluster functions and events are available on process or
  just on the worker, as well as which are not available in children,
- don't describe events as the same, when they have receive different
  arguments
- fix misleading disconnect example: since disconnect already calls
  close on all servers, doing it again in the example is a no-op, not
  the "force close" it was claimed to be
- document the error event, not catching it will kill your node
- describe suicide better, it is important, and a bit unintuitive
  (process.exit() is not suicide?)
- use worker consistently throughout, instead of child.
2013-10-16 15:10:13 -07:00
..
_toc.markdown doc: call console module 'console' not 'stdio' 2013-06-18 22:50:19 +02:00
addons.markdown doc: addon: fix object instantiation examples 2013-10-10 14:09:39 +02:00
all.markdown doc: call console module 'console' not 'stdio' 2013-06-18 22:50:19 +02:00
assert.markdown doc: update assert.doesNotThrow() docs 2012-08-29 02:36:22 +02:00
buffer.markdown buffer: strip high bits when converting to ascii 2013-03-08 14:42:15 -08:00
child_process.markdown doc: child_process corrections and cleanups 2013-10-16 15:10:13 -07:00
cluster.markdown doc: cluster documentation cleanup and corrections 2013-10-16 15:10:13 -07:00
console.markdown doc: call console module 'console' not 'stdio' 2013-06-18 22:50:19 +02:00
crypto.markdown crypto: make getCiphers() return non-SSL ciphers 2013-03-25 18:42:07 +01:00
debugger.markdown debugger: breakpoints in scripts not loaded yet 2013-05-02 08:52:58 +02:00
dgram.markdown doc: Minor typos in dgram doc 2013-08-19 17:55:58 -07:00
dns.markdown doc: debugger, dns, http: fix grammar 2013-03-28 16:50:37 +01:00
documentation.markdown doc: modify documentation style about 'Stability: 5' 2013-01-17 13:51:21 +01:00
domain.markdown doc: document domain.enter() and domain.exit() 2013-08-05 13:11:38 +02:00
events.markdown doc: events: clarify 'newListener' emitter state 2013-07-18 20:49:24 +02:00
fs.markdown doc: add warning to fs.exists() documentation 2013-10-05 14:54:57 +02:00
globals.markdown doc: call console module 'console' not 'stdio' 2013-06-18 22:50:19 +02:00
http.markdown doc: http: reword IncomingMessage 'close' event 2013-10-16 12:56:13 +02:00
https.markdown https: Add secureProtocol docs 2013-05-28 21:43:37 +02:00
index.markdown
modules.markdown doc: improve exports/module.exports consistency 2013-05-15 21:06:32 +02:00
net.markdown doc: net: remove bad net.Server description 2013-10-10 14:34:16 +02:00
os.markdown doc: expand os.loadavg() section 2013-10-15 10:17:23 +02:00
path.markdown docs: update path.join() example for v0.10 2013-04-17 00:04:17 +02:00
process.markdown doc: document reserved status of SIGUSR1 2013-09-19 12:31:52 +02:00
punycode.markdown doc: add punycode.js documentation 2012-05-23 04:04:12 +02:00
querystring.markdown Merge remote-tracking branch 'ry/v0.6' into v0.6-merge 2012-03-03 23:38:52 -08:00
readline.markdown docs: update var names in readline docs to be consistent 2012-05-06 11:23:09 -07:00
repl.markdown doc: add prompt to fix repl_test.js example 2013-02-13 16:40:27 +01:00
stream.markdown doc: fix writable.write link 2013-09-04 10:25:51 +02:00
string_decoder.markdown string_decoder: Add 'end' method, do base64 properly 2012-10-11 16:46:18 -07:00
synopsis.markdown
timers.markdown doc: add setImmediate execute timing description 2013-02-15 16:11:05 -08:00
tls.markdown doc: fix typos in the tls NPNProtocols option 2013-09-16 13:57:34 -07:00
tty.markdown doc: fix formatting in tty.markdown 2013-03-26 16:09:51 +01:00
url.markdown doc: add url.resolve() usage examples 2013-03-04 20:54:36 +01:00
util.markdown doc: Adjust util stability index to 'API Frozen' 2013-08-27 19:52:49 -07:00
vm.markdown doc: vm: update github issues link 2013-06-28 12:31:37 +02:00
zlib.markdown zlib: Manage flush flags appropriately 2013-03-08 18:56:31 -08:00