delta/node.git/doc, branch master github.com: joyent/node.git comma 2015-08-06T05:33:29+00:00 Julien Valéry darul75@gmail.com 2015-07-02T10:06:51+00:00 75ceaa0d5ee1ae4bec6e9796e406aa2b31c2e8b5 PR-URL: https://github.com/joyent/node/pull/25615 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Steven R Loomis <srloomis@us.ibm.com> 
PR-URL: https://github.com/joyent/node/pull/25615
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Steven R Loomis <srloomis@us.ibm.com>
doc: Change the link for v8 docs to v8dox.com 2015-08-05T21:38:27+00:00 Chad Walker chad@chad-cat-lore-eddie.com 2015-07-10T15:52:43+00:00 2ffc000b65325358764cd2e57130eba3c14a8b7b No offense to @izs, but the doxygen he put up 3.5 years ago isn't accurate for node 0.12 nor io.js. I'm trying to keep up and have multiple sets of doxygen of v8 available at http://v8dox.com/ Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: https://github.com/joyent/node/pull/25658 
No offense to @izs, but the doxygen he put up 3.5 years ago isn't
accurate for node 0.12 nor io.js. I'm trying to keep up and have
multiple sets of doxygen of v8 available at http://v8dox.com/

Reviewed-By: James M Snell <jasnell@gmail.com>
PR-URL: https://github.com/joyent/node/pull/25658
doc: buffer, adding missing backtick 2015-08-05T19:05:43+00:00 Dyana Rose dyana.rose@gmail.com 2015-07-25T10:11:26+00:00 1a82c8381111fb57bef7e10d1df2ec721f5112a6 Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: https://github.com/joyent/node/pull/25767 
Reviewed-By: James M Snell <jasnell@gmail.com>
PR-URL: https://github.com/joyent/node/pull/25767
Update assert.markdown 2015-08-05T18:13:50+00:00 daveboivin dave.a.boivin@gmail.com 2015-07-30T21:58:48+00:00 99414b3bb67584ea593318247a4ac0ea74640616 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. Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: https://github.com/joyent/node/pull/25786 
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.

Reviewed-By: James M Snell <jasnell@gmail.com>
PR-URL: https://github.com/joyent/node/pull/25786
doc: additional refinement to readable event 2015-07-10T16:15:48+00:00 James M Snell jasnell@gmail.com 2015-07-09T23:35:32+00:00 6036e4f5a833b27fb474f3bf891c405606fdce19 Per https://github.com/joyent/node/pull/25635#discussion_r33973696 Additional refinement to the clarification on the `readable` event Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: https://github.com/joyent/node/pull/25635 
Per https://github.com/joyent/node/pull/25635#discussion_r33973696

Additional refinement to the clarification on the `readable` event

Reviewed-By: James M Snell <jasnell@gmail.com>
PR-URL: https://github.com/joyent/node/pull/25635
doc: readable event clarification 2015-07-10T16:15:47+00:00 James M Snell jasnell@gmail.com 2015-07-06T18:50:17+00:00 340e9f0edd3d32aed391e4be40a825b0c706ea87 per https://github.com/joyent/node/issues/14597 Indicate that `'readable'` indicates only that data can be read from the stream, not that there is actually data to be consumed. `readable.read([size])` can still return null. Includes an example that illustrates the point. Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: https://github.com/joyent/node/pull/25635 
per https://github.com/joyent/node/issues/14597

Indicate that `'readable'` indicates only that data can
be read from the stream, not that there is actually data
to be consumed. `readable.read([size])` can still return
null. Includes an example that illustrates the point.

Reviewed-By: James M Snell <jasnell@gmail.com>
PR-URL: https://github.com/joyent/node/pull/25635
doc: stream.unshift does not reset reading state 2015-07-10T16:15:47+00:00 James M Snell jasnell@gmail.com 2015-07-06T18:18:06+00:00 daed421e574ba733023d6179b9942bf846cf50d2 Per https://github.com/joyent/node/issues/14604, Document that performing an `unshift` during a read can have unexpected results. Following the `unshift` with a `push('')` resets the reading state appropriately. Also indicate that doing an `unshift` during a read is not optimal and should be avoided. Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: https://github.com/joyent/node/pull/25635 
Per https://github.com/joyent/node/issues/14604,

Document that performing an `unshift` during a read
can have unexpected results. Following the `unshift`
with a `push('')` resets the reading state appropriately.
Also indicate that doing an `unshift` during a read
is not optimal and should be avoided.

Reviewed-By: James M Snell <jasnell@gmail.com>
PR-URL: https://github.com/joyent/node/pull/25635
Update util.markdown 2015-07-10T16:15:47+00:00 Daniel Rentz danielrentz@users.noreply.github.com 2015-06-25T19:43:56+00:00 423c4335664e565f9a9d0545ee9e7bc3a71873e9 Fix for https://github.com/joyent/node/issues/25559 (Typo in example of util.deprecate() documentation) Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: https://github.com/joyent/node/pull/25635 
Fix for https://github.com/joyent/node/issues/25559 (Typo in example of util.deprecate() documentation)

Reviewed-By: James M Snell <jasnell@gmail.com>
PR-URL: https://github.com/joyent/node/pull/25635
doc: clarify Readable._read and Readable.push 2015-07-10T16:15:46+00:00 fresheneesz bitetrudpublic@gmail.com 2015-06-25T23:05:40+00:00 9faae7abaf89b618e436dba5d5cf119eba930c04 Minor clarifications around Readable._read and Readable.push to make their implementation/usage easier to understand. https://github.com/joyent/node/issues/14124#issuecomment-115392674 Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: https://github.com/joyent/node/pull/25635 
Minor clarifications around Readable._read and Readable.push
to make their implementation/usage easier to understand.

https://github.com/joyent/node/issues/14124#issuecomment-115392674

Reviewed-By: James M Snell <jasnell@gmail.com>
PR-URL: https://github.com/joyent/node/pull/25635
doc: two minor stream doc improvements 2015-07-10T16:15:46+00:00 James M Snell jasnell@gmail.com 2015-07-01T19:52:47+00:00 f7af915d52a8eca8d8515c6602bf511db1b55f02 per: https://github.com/joyent/node/issues/14596 1. document that a runtime error will occur if you attempt to unshift after the end event 2. document that calling read after the end event will return null and will not trigger a runtime error Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: https://github.com/joyent/node/pull/25635 
per: https://github.com/joyent/node/issues/14596

1. document that a runtime error will occur if you attempt
   to unshift after the end event
2. document that calling read after the end event will return
   null and will not trigger a runtime error

Reviewed-By: James M Snell <jasnell@gmail.com>
PR-URL: https://github.com/joyent/node/pull/25635