James M Snell
1a004f1187
doc: improvements to debugger.markdown copy
...
General improvements to debugger.markdown
PR-URL: https://github.com/nodejs/node/pull/4436
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Stephen Belanger <admin@stephenbelanger.com >
Reviewed-By: Minwoo Jung <jmwsoft@gmail.com >
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl >
2015-12-30 11:21:13 -08:00
James M Snell
a0130e16e5
doc: improvements to events.markdown copy
...
General improvements to events.markdown copy including a
bit of restructuring and improved examples
PR-URL: https://github.com/nodejs/node/pull/4468
Reviewed-By: Myles Borins <myles.borins@gmail.com >
Reviewed-By: Stephen Belanger <admin@stephenbelanger.com >
2015-12-30 10:50:52 -08:00
James M Snell
7ee1685d74
doc: improvements to dns.markdown copy
...
General improvements to dns.markdown copy and examples
PR-URL: https://github.com/nodejs/node/pull/4449
Reviewed-By: Roman Reiss <me@silverwind.io >
Reviewed-By: Stephen Belanger <admin@stephenbelanger.com >
2015-12-30 10:48:10 -08:00
James M Snell
e4c835e1cb
doc: improvements to console.markdown copy
...
Several improvements including a few new examples
PR-URL: https://github.com/nodejs/node/pull/4428
Reviewed-By: Stephen Belanger <admin@stephenbelanger.com >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Evan Lucas <evanlucas@me.com >
2015-12-30 10:42:29 -08:00
James M Snell
7d5c1b5b1a
doc: improve child_process.markdown copy
...
General improvements to child_process.markdown
PR-URL: https://github.com/nodejs/node/pull/4383
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
2015-12-30 10:29:48 -08:00
Rich Trott
f241d6685b
doc: copyedit setTimeout() documentation
...
Copyedit the documentation for setTimeout() and enforce wrapping at 80
characters in the markdown file for nearby text.
PR-URL: https://github.com/nodejs/node/pull/4434
Reviewed-By: Trevor Norris <trev.norris@gmail.com >
Reviewed-By: jasnell - James M Snell <jasnell@gmail.com >
Reviewed-By: Stephan Belanger <admin@stephenbelanger.com >
2015-12-29 19:13:13 -08:00
Rich Trott
312b4d6371
doc: fix formatting in process.markdown
...
All the other properties get an h2/## but process.connected gets an
h3/### for no discernible reason. Change it to h2/## like the others.
PR-URL: https://github.com/nodejs/node/pull/4433
Reviewed-By: Roman Reiss <me@silverwind.io >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Stephan Belanger <admin@stephenbelanger.com >
Reviewed-By: Roman Klauke <romaaan.git@gmail.com >
2015-12-29 19:06:23 -08:00
James M Snell
3e648eb2ca
doc: improve assert.markdown copy
...
General improvements to assert.markdown copy including
new and improved examples
PR-URL: https://github.com/nodejs/node/pull/4360
Reviewed-By: Trevor Norris <trev.norris@gmail.com >
2015-12-28 12:14:49 -08:00
Adri Van Houdt
2fd3d8aee6
doc: improve grammar in tls docs
...
Fix : #4246
PR-URL: https://github.com/nodejs/node/pull/4315
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Fedor Indutny <fedor@indutny.com >
2015-12-23 17:17:51 -08:00
James M Snell
67b109a4b4
doc: improvements to buffer.markdown copy
...
General improvements to buffer.markdown including new examples,
a few fixes to existing examples, consistent formatting and
others
PR-URL: https://github.com/nodejs/node/pull/4370
Reviewed-By: Trevor Norris <trev.norris@gmail.com >
2015-12-23 13:47:54 -08:00
James M Snell
d5863bc0f4
doc: improve addons.markdown copy
...
General improvements to the documentation in addons.markdown.
PR-URL: https://github.com/nodejs/node/pull/4320
Reviewed-By: Matteo Collina <matteo.collina@gmail.com >
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl >
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com >
2015-12-23 12:19:42 -08:00
James M Snell
9b21119e17
doc: fix, modernize examples in docs
...
* Use single quotes consistently
* Modernize examples to use template strings and arrow funcs
* Fix a few typos
* Example edits for consistency
PR-URL: https://github.com/nodejs/node/pull/4282
Reviewed-By: Chris Dickinson <christopher.s.dickinson@gmail.com >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
2015-12-17 08:07:29 -08:00
chrisjohn404
f2bddc14f6
doc: Typo in buffer.markdown referencing buf.write()
...
The buffer's write function is documented below the
buf.toString function and all of the docs reference
"buf" instead of "buffer".
PR-URL: https://github.com/nodejs/node/pull/4324
Reviewed-By: James M Snell <jasnell@gmail.com >
2015-12-17 07:55:09 -08:00
Nicholas Young
4637168f81
doc: fix link in addons.markdown
...
Update link from github.com/rvagg to github.com/nodejs
PR-URL: https://github.com/nodejs/node/pull/4331
Reviewed-By: James M Snell <jasnell@gmail.com >
2015-12-17 07:48:33 -08:00
Jackson Tian
a8854e5b59
doc: document the cache parameter for fs.realpathSync
...
PR-URL: https://github.com/nodejs/node/pull/4285
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
2015-12-16 08:41:45 -08:00
Jan Schär
9e1b7aa874
doc: document backlog for server.listen() variants
...
The backlog parameter is supported by all variations of
net.Server.listen(), but wasn't consistently documented. This
commit brings the documentation into a more consistent state.
Refs: https://github.com/nodejs/node/pull/4056
PR-URL: https://github.com/nodejs/node/pull/4025
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Fedor Indutny <fedor.indutny@gmail.com >
2015-12-16 10:58:51 -05:00
Bryan English
7a518788e9
doc, test: symbols as event names
...
* Document that Symbol can used as event names.
* Add test for using Symbol as event names
PR-URL: https://github.com/nodejs/node/pull/4151
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
2015-12-14 15:31:32 -08:00
Lenny Markus
9538fd02e5
doc: clarify error events in HTTP module documentation
...
Make it clear that error with throw if error listener is
not registered.
PR-URL: https://github.com/nodejs/node/pull/4275
Reviewed-By: Brian White <mscdex@mscdex.net >
Reviewed-By: James M Snell <jasnell@gmail.com >
2015-12-14 15:11:18 -08:00
Hideki Yamamura
c6efd535e4
doc: fix improper http.get sample code
...
Refs: https://github.com/nodejs/node-v0.x-archive/pull/25471
Refs: https://github.com/nodejs/node-v0.x-archive/issues/8443
PR-URL: https://github.com/nodejs/node/pull/4263
Reviewed-By: Rod Vagg <rod@vagg.org >
Reviewed-By: Myles Borins <myles.borins@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
2015-12-14 14:54:22 -08:00
Arthur Gautier
671347cf13
doc: fixup socket.remoteAddress
...
remoteAddress may be undefined under certain conditions
Signed-off-by: Arthur Gautier <baloo@gandi.net >
PR-URL: https://github.com/nodejs/node/pull/4198
Reviewed-By: Evan Lucas <evanlucas@me.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Rod Vagg <rod@vagg.org >
2015-12-14 17:25:36 +11:00
Rich Trott
f050cab3d8
doc: copyedit console doc
...
PR-URL: https://github.com/nodejs/node/pull/4225
Reviewed-By: Brian White <mscdex@mscdex.net >
Reviewed-By: Michaël Zasso <mic.besace@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
2015-12-11 21:19:57 -08:00
Fedor Indutny
c5b4f6bc99
tls: introduce secureContext for tls.connect
...
Add `secureContext` option to `tls.connect`. It is useful for caching
client certificates, key, and CA certificates.
PR-URL: https://github.com/nodejs/node/pull/4246
Reviewed-By: James M Snell <jasnell@gmail.com >
2015-12-11 19:53:30 -05:00
janriemer
1a21a5368b
doc: move description of 'equals' method to right place
...
the description of buffer.equals(otherBuffer) was at the wrong
place; move it underneath the method signature
PR-URL: https://github.com/nodejs/node/pull/4227
Reviewed-By: Brian White <mscdex@mscdex.net >
Reviewed-By: James M Snell <jasnell@gmail.com >
2015-12-11 10:40:56 -08:00
Tom Gallacher
9a9c5259bf
doc: Fixing broken links to the v8 wiki
...
PR-URL: https://github.com/nodejs/node/pull/4241
Reviewed-By: Evan Lucas <evanlucas@me.com >
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl >
Reviewed-By: Minwoo Jung <jmwsoft@gmail.com >
2015-12-11 10:24:46 -08:00
Alexander Martin
67e181986a
buffer: add includes() for parity with TypedArray
...
Add Buffer#includes() by wrapping an indexOf and performing a strict
equals check to -1.
The includes method takes the search value, byteOffset, and encoding as
arguments.
The test is a modified version of the indexOf test.
Fixes: https://github.com/nodejs/node/issues/3552
PR-URL: https://github.com/nodejs/node/pull/3567
Reviewed-By: Trevor Norris <trev.norris@gmail.com >
Reviewed-By: Evan Lucas <evanlucas@me.com >
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
2015-12-10 13:41:40 -07:00
Rich Trott
37ed05b8c1
doc: copyedit child_process doc
...
PR-URL: https://github.com/nodejs/node/pull/4188
Reviewed-By: Michaël Zasso <mic.besace@gmail.com >
Reviewed-By: Minwoo Jung <jmwsoft@gmail.com >
2015-12-09 16:56:26 -08:00
Rich Trott
e47ae5808b
doc: copyedit buffer doc
...
PR-URL: https://github.com/nodejs/node/pull/4187
Reviewed-By: Michaël Zasso <mic.besace@gmail.com >
Reviewed-By: Roman Reiss <me@silverwind.io >
2015-12-09 16:49:04 -08:00
Rich Trott
70fb06a90b
doc: clarify assert.fail doc
...
PR-URL: https://github.com/nodejs/node/pull/4186
Reviewed-By: Michaël Zasso <mic.besace@gmail.com >
Reviewed-By: Roman Klauke <romaaan.git@gmail.com >
Reviewed-By: Minwoo Jung <jmwsoft@gmail.com >
2015-12-09 16:43:48 -08:00
Rich Trott
e3187cc81e
doc: copyedit addons doc
...
PR-URL: https://github.com/nodejs/node/pull/4185
Reviewed-By: Roman Reiss <me@silverwind.io >
Reviewed-By: Michaël Zasso <mic.besace@gmail.com >
2015-12-09 16:37:13 -08:00
Ben Noordhuis
73a9a6fc92
doc: harmonize description of ca argument
...
Different sections said different things about what the `ca` argument
should look like. This commit harmonizes them.
Ref: https://github.com/nodejs/node/pull/4099
PR-URL: https://github.com/nodejs/node/pull/4213
Reviewed-By: Roman Reiss <me@silverwind.io >
2015-12-09 22:29:37 +01:00
Roman Klauke
dfc8bedbc5
doc: change references from node to Node.js
...
Some API doc referenced Node.js with "node" or "node.js". This commit
replaces these references.
PR-URL:https://github.com/nodejs/node/pull/4177
Reviewed-By: Evan Lucas <evanlucas@me.com >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Minwoo Jung <jmwsoft@gmail.com >
2015-12-10 00:09:38 +09:00
Michael Ruddy
322b36c0a1
crypto: simplify using pre-existing keys with ECDH
...
These changes simplify using ECDH with private keys that are not
dynamically generated with ECDH.generateKeys.
Support for computing the public key corresponding to the given private
key was added. Validity checks to reduce the possibility of computing
a weak or invalid shared secret were also added.
Finally, ECDH.setPublicKey was softly deprecated.
PR-URL: https://github.com/nodejs/node/pull/3511
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl >
Reviewed-By: Shigeki Ohtsu <ohtsu@iij.ad.jp >
2015-12-07 12:44:46 +01:00
yorkie
8c35903ba3
fs,doc: use target instead of destination
...
PR-URL: https://github.com/nodejs/node/pull/3912
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Evan Lucas <evanlucas@me.com >
Reviewed-By: Michaël Zasso <mic.besace@gmail.com >
Reviewed-By: Bert Belder <bertbelder@gmail.com >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
2015-12-05 18:25:05 -08:00
fansworld-claudio
2a29b70b37
doc: url.format - true slash postfix behaviour
...
Change url.format's references to slash postfixing to reflect
true behaviour (it only automatically postfixes slashes to the
slashedProtocols when host is present).
Fixes : #3361
PR-URL: https://github.com/nodejs/node/pull/4119
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Roman Reiss <me@silverwind.io >
Reviewed-By: Minwoo Jung <jmwsoft@gmail.com >
2015-12-06 09:02:55 +09:00
yorkie
cc2ceb6cb9
doc: improve child_process.markdown wording
...
PR-URL: https://github.com/nodejs/node/pull/4138
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Minwoo Jung <jmwsoft@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
2015-12-04 10:26:29 -08:00
jpersson
7e4f22ca13
doc: update links to use https where possible
...
PR-URL: https://github.com/nodejs/node/pull/4054
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Roman Reiss <me@silverwind.io >
2015-12-03 13:40:10 -08:00
jpersson
14b3aab7d2
doc: add links and backticks around names
...
* add backticks around names
* add single quotes around event names
* add parenthesis after function names
* add internal links between different sections
* add external links to MDN for some JavaScript references
* sort the link definitions alphabetically
PR-URL: https://github.com/nodejs/node/pull/4054
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Roman Reiss <me@silverwind.io >
2015-12-03 13:39:09 -08:00
Scott Buchanan
816e66f0ec
doc: standardize references to node.js in docs
...
trivial commit to fix a couple inconsistent references to
the name of the project
PR-URL: https://github.com/nodejs/node/pull/4136
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Roman Klauke <romaaan.git@gmail.com >
Reviewed-By: Roman Reiss <me@silverwind.io >
2015-12-03 12:28:10 -08:00
Jan Krems
8eb153d00b
doc: reword https.Agent example text
...
PR-URL: https://github.com/nodejs/node/pull/4075
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
2015-12-02 11:01:29 -05:00
Luigi Pinca
15dc37ff4f
doc: fix internal link to child.send()
...
PR-URL: https://github.com/nodejs/node/pull/4089
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Evan Lucas <evanlucas@me.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
2015-12-01 10:05:07 -05:00
yorkie
2fb34b6132
doc: fix the exception description
...
A value shouldn't be described as doing inherit from some class, more
strictly, the value is an instance of the class `Error`.
PR-URL: https://github.com/nodejs/node/pull/3658
Reviewed-By: Evan Lucas <evanlucas@me.com >
Reviewed-By: Stephan Belanger <admin@stephenbelanger.com >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Rich Trott <rtrott@gmail.com >
2015-11-30 18:29:52 -08:00
Nathan Woltman
d1000b4137
path: make format() consistent and more functional
...
Make the win32 and posix versions of path.format() consistent in when
they add a directory separator between the dir and base parts of the
path (always add it unless the dir part is the same as the root).
Also, path.format() is now more functional in that it uses the name
and ext parts of the path if the base part is left out and it uses
the root part if the dir part is left out.
Reviewed-By: João Reis <reis@janeasystems.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
PR-URL: https://github.com/nodejs/node/pull/2408
2015-11-27 11:53:33 +00:00
Bryan English
6f87aa9a12
doc: message.header duplication correction
...
The old version of the text here was slightly incorrect, so it
just defers the details to the section in which they're fully
described.
PR-URL: https://github.com/nodejs/node/pull/3997
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Evan Lucas <evanlucas@me.com >
2015-11-24 16:16:01 +01:00
Lewis Cowper
3becac2e60
doc: replace sane with reasonable
...
Removing ableist language because we don't need to make the comparison
to people with mental health issues to get our point across.
PR-URL: https://github.com/nodejs/node/pull/3980
Reviewed-By: Evan Lucas <evanlucas@me.com >
Reviewed-By: Michaël Zasso <mic.besace@gmail.com >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
2015-11-23 14:47:55 +01:00
Tom Gallacher
d16def5326
doc: Adding best practises for crypto.pbkdf2
...
Added some information around usages of how to use iterations, how to
choose decent salts and updating the example to have a significant
work factor and to use sha512.
PR-URL: https://github.com/nodejs/node/pull/3290
Reviewed-By: Fedor Indutny <fedor@indutny.com >
Reviewed-By: Shigeki Ohtsu <ohtsu@iij.ad.jp >
2015-11-23 17:49:52 +09:00
Carl Lei
615fba3bcf
doc: numeric flags to fs.open
...
This has been supperted for long but never tested nor documented.
PR-URL: https://github.com/nodejs/node/pull/3641
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl >
Reviewed-By: James M Snell <jasnell@gmail.com >
2015-11-22 13:35:09 +01:00
Carl Lei
3f4409e571
doc: clarify that fs streams expect blocking fd
...
This clarifies that fs.createReadStream and fs.createWriteStream, when
passed a fd, expects the fd to be blocking, and suggests net.Socket as
an alternative.
PR-URL: https://github.com/nodejs/node/pull/3641
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl >
Reviewed-By: James M Snell <jasnell@gmail.com >
2015-11-22 13:34:30 +01:00
Tristian Flanagan
dfee4e3712
module: fix column offsets in errors
...
Because Node modules are wrapped, errors on the first line
of a file leak the wrapper to the user and report the wrong
column number. This commit adds a line break to the module
wrapper so that the first line is treated the same as all
other lines. To compensate for the additional line, a line
offset of -1 is also applied to errors.
Fixes: https://github.com/nodejs/node/issues/2860
PR-URL: https://github.com/nodejs/node/pull/2867
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
2015-11-20 16:26:24 -05:00
Alexander Gromnitsky
94c3507f5c
doc: fix broken references
...
PR-URL: https://github.com/nodejs/node/pull/3944
Reviewed-By: targos - Michaël Zasso <mic.besace@gmail.com >
Reviewed-By: Myles Borins <mborins@us.ibm.com >
2015-11-20 11:52:23 -08:00
Martin Forsberg
55b1eccae6
doc: move fs.existsSync() deprecation message
...
This commit moves the deprecation message for fs.existsSync()
above the function description, making message placement
uniform across the documentation.
PR-URL: https://github.com/nodejs/node/pull/3942
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
2015-11-20 14:11:02 -05:00