Vse Mozhet Byt
14e6274bed
doc: unify optional arguments format in headings
...
Make space and comma distribution in some headings
consistent with the majority of headings.
PR-URL: https://github.com/nodejs/node/pull/22397
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Rich Trott <rtrott@gmail.com >
Reviewed-By: Tobias Nießen <tniessen@tnie.de >
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
2018-08-19 21:45:39 +03:00
Ouyang Yadong
2bea9cefbc
dgram: implement socket.bind({ fd })
...
dgram: Implement binding an existing `fd`. Allow pass a `fd` property
to `socket.bind()` in dgram.
src: Add `UDPWrap::Open`
PR-URL: https://github.com/nodejs/node/pull/21745
Fixes: https://github.com/nodejs/node/issues/14961
Reviewed-By: Matteo Collina <matteo.collina@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
2018-08-06 11:05:51 +02:00
Sam Ruby
40c85ff063
doc: declare all parameter types
...
PR-URL: https://github.com/nodejs/node/pull/21782
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de >
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com >
2018-07-15 23:57:35 +03:00
Rich Trott
85fe134026
doc: remove spaces around slashes
...
Remove spaces around slash characters in documentation. This change
sometimes rewords the content where the slash construction may not be
what is called for.
PR-URL: https://github.com/nodejs/node/pull/21140
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com >
Reviewed-By: Michaël Zasso <targos@protonmail.com >
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
2018-06-06 21:23:00 -07:00
Vse Mozhet Byt
7588ceaf35
doc: add more missing backticks
...
Also, fix some other nits in passing
(formatting, punctuation, typos, redundancy, obsoleteness).
PR-URL: https://github.com/nodejs/node/pull/20438
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
2018-05-03 02:12:07 +03:00
Vse Mozhet Byt
392d80a617
doc: add missing periods or colons
...
Some other formatting nits were fixed
and some superfluous descriptions were simplified in passing.
PR-URL: https://github.com/nodejs/node/pull/20401
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de >
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com >
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
2018-05-02 06:17:08 +03:00
Vse Mozhet Byt
a3bd06a5e6
doc: remove redundant empty lines
...
PR-URL: https://github.com/nodejs/node/pull/20398
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com >
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de >
2018-04-29 17:48:43 +03:00
Vse Mozhet Byt
9c8857d946
doc: add quotes for event names + fix similar nits
...
PR-URL: https://github.com/nodejs/node/pull/19915
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com >
2018-04-11 21:42:38 -07:00
Vse Mozhet Byt
df5d41bf93
doc: add and unify even more return values
...
PR-URL: https://github.com/nodejs/node/pull/19955
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de >
Reviewed-By: James M Snell <jasnell@gmail.com >
2018-04-12 03:18:01 +03:00
Vse Mozhet Byt
de0053cc32
doc: fix various nits
...
* Replace 2 hyphens (--) by spaced m-dashes (—) as per STYLE_GUIDE.md.
* Space infix operators.
* Unify quotes in inline code spans (use only single quotes).
* Unify `* Returns:` (eliminate deviations).
* Dedupe spaces.
PR-URL: https://github.com/nodejs/node/pull/19743
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com >
2018-04-04 13:45:39 +03:00
Vse Mozhet Byt
237cbe10fb
doc,tools: formalize, unify, codify default values
...
PR-URL: https://github.com/nodejs/node/pull/19737
Reviewed-By: Gus Caplan <me@gus.host >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com >
2018-04-04 12:30:36 +03:00
Thomas Hunter II
cdfe47b323
doc: remove use of "random port" re dgram send
...
PR-URL: https://github.com/nodejs/node/pull/19620
Reviewed-By: Rich Trott <rtrott@gmail.com >
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com >
Reviewed-By: Anna Henningsen <anna@addaleax.net >
2018-03-27 03:35:41 +03:00
estrada9166
a29089d7c8
doc: add new documentation lint rule
...
Add 80 characters limit to docs.
Change docs to fit 80 characters per row.
PR-URL: https://github.com/nodejs/node/pull/18726
Fixes: https://github.com/nodejs/node/issues/18703
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de >
Reviewed-By: Matteo Collina <matteo.collina@gmail.com >
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com >
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com >
2018-02-23 16:26:29 +00:00
Vse Mozhet Byt
d955645e4b
doc: decapitalize primitive types
...
PR-URL: https://github.com/nodejs/node/pull/18110
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
2018-01-12 02:47:22 +02:00
Vse Mozhet Byt
11a1bc1136
doc: replace wrong U+00A0 by common spaces
...
PR-URL: https://github.com/nodejs/node/pull/17940
Reviewed-By: Anna Henningsen <anna@addaleax.net >
Reviewed-By: Jon Moss <me@jonathanmoss.me >
2018-01-02 01:58:15 +02:00
sreepurnajasti
b21e3f0711
doc: fix duplicate words & spellings in docs
...
PR-URL: https://github.com/nodejs/node/pull/17923
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com >
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: Richard Lau <riclau@uk.ibm.com >
Reviewed-By: Tobias Nießen <tniessen@tnie.de >
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Jon Moss <me@jonathanmoss.me >
2017-12-31 18:14:25 +01:00
Vse Mozhet Byt
bbd95554c0
doc: fix a link in dgram.md
...
PR-URL: https://github.com/nodejs/node/pull/17107
Refs: https://en.wikipedia.org/w/index.php?title=IPv6_address&type=revision&diff=809494791&oldid=804196124
Reviewed-By: Rich Trott <rtrott@gmail.com >
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: Tobias Nießen <tniessen@tnie.de >
2017-11-18 14:11:41 +02:00
Vidya Subramanyam
b9a772116b
doc: correct the spelling of omitting in dgram.md
...
PR-URL: https://github.com/nodejs/node/pull/16910
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Tobias Nießen <tniessen@tnie.de >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com >
2017-11-11 10:19:01 +01:00
Vse Mozhet Byt
83fcb9f075
doc: fix a link in dgram.md
...
PR-URL: https://github.com/nodejs/node/pull/16854
Reviewed-By: Khaidi Chu <i@2333.moe >
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com >
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
2017-11-07 14:16:17 +02:00
Alessandro Vergani
34c47ed486
doc: fix dgram.md typos
...
socket.getRecvBufferSize() and socket.getSendBufferSize()
do not take any parameter
PR-URL: https://github.com/nodejs/node/pull/16183
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Yuta Hiroto <hello@about-hiroppy.com >
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com >
2017-10-14 12:37:33 +08:00
Myles Borins
b7fec86bf2
2017-10-11, Node.js Version 8.7.0 (Current)
...
Notable Changes:
* deps:
* update npm to 5.4.2
https://github.com/nodejs/node/pull/15600
* upgrade libuv to 1.15.0
https://github.com/nodejs/node/pull/15745
* update V8 to 6.1.534.42
https://github.com/nodejs/node/pull/15393
* dgram:
* support for setting dgram socket buffer size
https://github.com/nodejs/node/pull/13623
* fs:
* add support O_DSYNC file open constant
https://github.com/nodejs/node/pull/15451
* util:
* deprecate obj.inspect for custom inspection
https://github.com/nodejs/node/pull/15631
* tools, build:
* there is a fancy new macOS installer
https://github.com/nodejs/node/pull/15179
* Added new collaborator
* bmeurer - Benedikt Meurer - https://github.com/bmeurer
* kfarnung - Kyle Farnung - https://github.com/kfarnung
PR-URL: https://github.com/nodejs/node/pull/15762
2017-10-11 16:51:50 -04:00
Gibson Fahnestock
1175c9dca3
doc: standardize function param/object prop style
...
PR-URL: https://github.com/nodejs/node/pull/13769
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com >
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de >
2017-09-28 02:26:56 -03:00
James M Snell
05e4c1d6bc
2017-09-26, Node.js Version 8.6.0 (Current)
...
* **crypto**
* Support for multiple ECDH curves. [#15206 ](https://github.com/nodejs/node/pull/15206 )
* **dgram**
* Added `setMulticastInterface()` API. [#7855 ](https://github.com/nodejs/node/pull/7855 )
* Custom lookup functions are now supported. [#14560 ](https://github.com/nodejs/node/pull/14560 )
* **n-api**
* The command-line flag is no longer required to use N-API. [#14902 ](https://github.com/nodejs/node/pull/14902 )
* **tls**
* Docs-only deprecation of `parseCertString()`. [#14245 ](https://github.com/nodejs/node/pull/14245 )
* **New Contributors**
* Welcome Sebastiaan Deckers (@sebdeckers) as a new Collaborator! [#15354 ](https://github.com/nodejs/node/pull/15354 )
2017-09-26 14:55:39 -07:00
Jon Moss
75f7b2f577
doc: do not begin yaml value with backtick
...
Will break YAML parsing!
See details in the PR.
PR-URL: https://github.com/nodejs/node/pull/15447
Fixes: https://github.com/nodejs/node/issues/14930
Reviewed-By: Refael Ackermann <refack@gmail.com >
Reviewed-By: Anna Henningsen <anna@addaleax.net >
2017-09-17 19:29:46 +03:00
Will Young
4ae0afb12b
dgram: added setMulticastInterface()
...
Add wrapper for uv's uv_udp_set_multicast_interface which provides the
sender side mechanism to explicitly select an interface. The
equivalent receiver side mechanism is the optional 2nd argument of
addMembership().
PR-URL: https://github.com/nodejs/node/pull/7855
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Matteo Collina <matteo.collina@gmail.com >
2017-09-14 17:03:19 +02:00
Damien O'Reilly
2ac7b433b4
dgram: support for setting socket buffer size
...
* setRecvBufferSize(int) and setSendBufferSize(int)
* added docs for send/receive buffer sizes
* Added options support to set buffer sizes in
dgram.createSocket().
PR-URL: https://github.com/nodejs/node/pull/13623
Reviewed-By: Refael Ackermann <refack@gmail.com >
Reviewed-By: Anna Henningsen <anna@addaleax.net >
2017-09-13 11:23:04 -04:00
Chris Young
cacce304cb
doc: add links to alternative versions of doc
...
Each page of the API documentation should have links to other versions
of the same page. This will make it easier to switch between the current
"live" release at nodejs.org and LTS versions.
PR-URL: https://github.com/nodejs/node/pull/10958
Fixes: https://github.com/nodejs/node/issues/10726
Reviewed-By: Refael Ackermann <refack@gmail.com >
Reviewed-By: Evan Lucas <evanlucas@me.com >
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com >
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de >
2017-08-28 11:17:08 +02:00
cjihrig
5a050550d3
dgram: add custom lookup function in sockets
...
This commit adds support for custom DNS lookup functions in
dgram sockets. This is similar to the existing feature in net
sockets.
Refs: https://github.com/nodejs/node/issues/6189
PR-URL: https://github.com/nodejs/node/pull/14560
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Wyatt Preul <wpreul@gmail.com >
Reviewed-By: Evan Lucas <evanlucas@me.com >
2017-08-02 20:32:51 -04:00
James M Snell
43e4efdf21
2017-05-30, Version 8.0.0 (Current)
...
* **Async Hooks**
* The `async_hooks` module has landed in core
[[`4a7233c178`](https://github.com/nodejs/node/commit/4a7233c178 )]
[#12892 ](https://github.com/nodejs/node/pull/12892 ).
* **Buffer**
* Using the `--pending-deprecation` flag will cause Node.js to emit a
deprecation warning when using `new Buffer(num)` or `Buffer(num)`.
[[`d2d32ea5a2`](https://github.com/nodejs/node/commit/d2d32ea5a2 )]
[#11968 ](https://github.com/nodejs/node/pull/11968 ).
* `new Buffer(num)` and `Buffer(num)` will zero-fill new `Buffer` instances
[[`7eb1b4658e`](https://github.com/nodejs/node/commit/7eb1b4658e )]
[#12141 ](https://github.com/nodejs/node/pull/12141 ).
* Many `Buffer` methods now accept `Uint8Array` as input
[[`beca3244e2`](https://github.com/nodejs/node/commit/beca3244e2 )]
[#10236 ](https://github.com/nodejs/node/pull/10236 ).
* **Child Process**
* Argument and kill signal validations have been improved
[[`97a77288ce`](https://github.com/nodejs/node/commit/97a77288ce )]
[#12348 ](https://github.com/nodejs/node/pull/12348 ),
[[`d75fdd96aa`](https://github.com/nodejs/node/commit/d75fdd96aa )]
[#10423 ](https://github.com/nodejs/node/pull/10423 ).
* Child Process methods accept `Uint8Array` as input
[[`627ecee9ed`](https://github.com/nodejs/node/commit/627ecee9ed )]
[#10653 ](https://github.com/nodejs/node/pull/10653 ).
* **Console**
* Error events emitted when using `console` methods are now supressed.
[[`f18e08d820`](https://github.com/nodejs/node/commit/f18e08d820 )]
[#9744 ](https://github.com/nodejs/node/pull/9744 ).
* **Dependencies**
* The npm client has been updated to 5.0.0
[[`3c3b36af0f`](https://github.com/nodejs/node/commit/3c3b36af0f )]
[#12936 ](https://github.com/nodejs/node/pull/12936 ).
* V8 has been updated to 5.8 with forward ABI stability to 6.0
[[`60d1aac8d2`](https://github.com/nodejs/node/commit/60d1aac8d2 )]
[#12784 ](https://github.com/nodejs/node/pull/12784 ).
* **Domains**
* Native `Promise` instances are now `Domain` aware
[[`84dabe8373`](https://github.com/nodejs/node/commit/84dabe8373 )]
[#12489 ](https://github.com/nodejs/node/pull/12489 ).
* **Errors**
* We have started assigning static error codes to errors generated by Node.js.
This has been done through multiple commits and is still a work in
progress.
* **File System**
* The utility class `fs.SyncWriteStream` has been deprecated
[[`7a55e34ef4`](https://github.com/nodejs/node/commit/7a55e34ef4 )]
[#10467 ](https://github.com/nodejs/node/pull/10467 ).
* The deprecated `fs.read()` string interface has been removed
[[`3c2a9361ff`](https://github.com/nodejs/node/commit/3c2a9361ff )]
[#9683 ](https://github.com/nodejs/node/pull/9683 ).
* **HTTP**
* Improved support for userland implemented Agents
[[`90403dd1d0`](https://github.com/nodejs/node/commit/90403dd1d0 )]
[#11567 ](https://github.com/nodejs/node/pull/11567 ).
* Outgoing Cookie headers are concatenated into a single string
[[`d3480776c7`](https://github.com/nodejs/node/commit/d3480776c7 )]
[#11259 ](https://github.com/nodejs/node/pull/11259 ).
* The `httpResponse.writeHeader()` method has been deprecated
[[`fb71ba4921`](https://github.com/nodejs/node/commit/fb71ba4921 )]
[#11355 ](https://github.com/nodejs/node/pull/11355 ).
* New methods for accessing HTTP headers have been added to `OutgoingMessage`
[[`3e6f1032a4`](https://github.com/nodejs/node/commit/3e6f1032a4 )]
[#10805 ](https://github.com/nodejs/node/pull/10805 ).
* **Lib**
* All deprecation messages have been assigned static identifiers
[[`5de3cf099c`](https://github.com/nodejs/node/commit/5de3cf099c )]
[#10116 ](https://github.com/nodejs/node/pull/10116 ).
* The legacy `linkedlist` module has been removed
[[`84a23391f6`](https://github.com/nodejs/node/commit/84a23391f6 )]
[#12113 ](https://github.com/nodejs/node/pull/12113 ).
* **N-API**
* Experimental support for the new N-API API has been added
[[`56e881d0b0`](https://github.com/nodejs/node/commit/56e881d0b0 )]
[#11975 ](https://github.com/nodejs/node/pull/11975 ).
* **Process**
* Process warning output can be redirected to a file using the
`--redirect-warnings` command-line argument
[[`03e89b3ff2`](https://github.com/nodejs/node/commit/03e89b3ff2 )]
[#10116 ](https://github.com/nodejs/node/pull/10116 ).
* Process warnings may now include additional detail
[[`dd20e68b0f`](https://github.com/nodejs/node/commit/dd20e68b0f )]
[#12725 ](https://github.com/nodejs/node/pull/12725 ).
* **REPL**
* REPL magic mode has been deprecated
[[`3f27f02da0`](https://github.com/nodejs/node/commit/3f27f02da0 )]
[#11599 ](https://github.com/nodejs/node/pull/11599 ).
* **Src**
* `NODE_MODULE_VERSION` has been updated to 57
(https://github.com/nodejs/node/commit/ec7cbaf266 )]
[#12995 ](https://github.com/nodejs/node/pull/12995 ).
* Add `--pending-deprecation` command-line argument and
`NODE_PENDING_DEPRECATION` environment variable
[[`a16b570f8c`](https://github.com/nodejs/node/commit/a16b570f8c )]
[#11968 ](https://github.com/nodejs/node/pull/11968 ).
* The `--debug` command-line argument has been deprecated. Note that
using `--debug` will enable the *new* Inspector-based debug protocol
as the legacy Debugger protocol previously used by Node.js has been
removed. [[`010f864426`](https://github.com/nodejs/node/commit/010f864426 )]
[#12949 ](https://github.com/nodejs/node/pull/12949 ).
* Throw when the `-c` and `-e` command-line arguments are used at the same
time [[`a5f91ab230`](https://github.com/nodejs/node/commit/a5f91ab230 )]
[#11689 ](https://github.com/nodejs/node/pull/11689 ).
* Throw when the `--use-bundled-ca` and `--use-openssl-ca` command-line
arguments are used at the same time.
[[`8a7db9d4b5`](https://github.com/nodejs/node/commit/8a7db9d4b5 )]
[#12087 ](https://github.com/nodejs/node/pull/12087 ).
* **Stream**
* `Stream` now supports `destroy()` and `_destroy()` APIs
[[`b6e1d22fa6`](https://github.com/nodejs/node/commit/b6e1d22fa6 )]
[#12925 ](https://github.com/nodejs/node/pull/12925 ).
* `Stream` now supports the `_final()` API
[[`07c7f198db`](https://github.com/nodejs/node/commit/07c7f198db )]
[#12828 ](https://github.com/nodejs/node/pull/12828 ).
* **TLS**
* The `rejectUnauthorized` option now defaults to `true`
[[`348cc80a3c`](https://github.com/nodejs/node/commit/348cc80a3c )]
[#5923 ](https://github.com/nodejs/node/pull/5923 ).
* The `tls.createSecurePair()` API now emits a runtime deprecation
[[`a2ae08999b`](https://github.com/nodejs/node/commit/a2ae08999b )]
[#11349 ](https://github.com/nodejs/node/pull/11349 ).
* A runtime deprecation will now be emitted when `dhparam` is less than
2048 bits [[`d523eb9c40`](https://github.com/nodejs/node/commit/d523eb9c40 )]
[#11447 ](https://github.com/nodejs/node/pull/11447 ).
* **URL**
* The WHATWG URL implementation is now a fully-supported Node.js API
[[`d080ead0f9`](https://github.com/nodejs/node/commit/d080ead0f9 )]
[#12710 ](https://github.com/nodejs/node/pull/12710 ).
* **Util**
* `Symbol` keys are now displayed by default when using `util.inspect()`
[[`5bfd13b81e`](https://github.com/nodejs/node/commit/5bfd13b81e )]
[#9726 ](https://github.com/nodejs/node/pull/9726 ).
* `toJSON` errors will be thrown when formatting `%j`
[[`455e6f1dd8`](https://github.com/nodejs/node/commit/455e6f1dd8 )]
[#11708 ](https://github.com/nodejs/node/pull/11708 ).
* Convert `inspect.styles` and `inspect.colors` to prototype-less objects
[[`aab0d202f8`](https://github.com/nodejs/node/commit/aab0d202f8 )]
[#11624 ](https://github.com/nodejs/node/pull/11624 ).
* The new `util.promisify()` API has been added
[[`99da8e8e02`](https://github.com/nodejs/node/commit/99da8e8e02 )]
[#12442 ](https://github.com/nodejs/node/pull/12442 ).
* **Zlib**
* Support `Uint8Array` in Zlib convenience methods
[[`91383e47fd`](https://github.com/nodejs/node/commit/91383e47fd )]
[#12001 ](https://github.com/nodejs/node/pull/12001 ).
* Zlib errors now use `RangeError` and `TypeError` consistently
[[`b514bd231e`](https://github.com/nodejs/node/commit/b514bd231e )]
[#11391 ](https://github.com/nodejs/node/pull/11391 ).
2017-05-30 10:58:31 -07:00
Daijiro Wachi
bfade5aacd
doc: remove unused/duplicated reference links
...
PR-URL: https://github.com/nodejs/node/pull/13066
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
2017-05-21 00:10:47 +02:00
Sam Roberts
ea1b8a5cbc
doc: sort bottom-of-file markdown links
...
PR-URL: https://github.com/nodejs/node/pull/12726
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com >
2017-05-08 09:30:55 -07:00
James M Snell
71f22c842b
doc: replace uses of you and other style nits
...
Replace uses of the pronouns `you` and `your` throughout
the docs + other minor style nits
PR-URL: https://github.com/nodejs/node/pull/12673
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com >
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com >
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com >
2017-04-28 07:57:11 -07:00
Vse Mozhet Byt
6ee6aaefa1
doc: add no-var, prefer-const in doc eslintrc
...
PR-URL: https://github.com/nodejs/node/pull/12563
Refs: https://github.com/nodejs/node/pull/12557#issuecomment-296015032
Reviewed-By: Teddy Katz <teddy.katz@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Timothy Gu <timothygu99@gmail.com >
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com >
Reviewed-By: Yuta Hiroto <hello@about-hiroppy.com >
2017-04-25 00:06:39 +03:00
Anna Henningsen
2dc1053b0a
dgram: support Uint8Array input to send()
...
Fixes: https://github.com/nodejs/node/issues/11954
Refs: https://github.com/nodejs/node/pull/11961
PR-URL: https://github.com/nodejs/node/pull/11985
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com >
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: Timothy Gu <timothygu99@gmail.com >
2017-03-27 02:03:51 +02:00
Roman Reiss
ff1361957d
doc: consistent case for primitive types
...
PR-URL: https://github.com/nodejs/node/pull/11167
Reviewed-By: Timothy Gu <timothygu99@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com >
2017-03-02 17:55:45 +01:00
Anna Henningsen
5da952472b
doc: document pending semver-major API changes
...
PR-URL: https://github.com/nodejs/node/pull/11489
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl >
Reviewed-By: Sam Roberts <vieuxtech@gmail.com >
Reviewed-By: Roman Reiss <me@silverwind.io >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Italo A. Casas <me@italoacasas.com >
2017-02-24 02:06:31 +01:00
Anna Henningsen
fb9572bf61
doc: add changelogs for dgram
...
PR-URL: https://github.com/nodejs/node/pull/11489
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl >
Reviewed-By: Sam Roberts <vieuxtech@gmail.com >
Reviewed-By: Roman Reiss <me@silverwind.io >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Italo A. Casas <me@italoacasas.com >
2017-02-24 02:06:31 +01:00
Vse Mozhet Byt
52b253677a
doc: fix sorting in API references
...
PR-URL: https://github.com/nodejs/node/pull/11331
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Sam Roberts <vieuxtech@gmail.com >
2017-02-20 13:11:11 -08:00
Christopher Hiller
32679c73c1
dgram: improve signature of Socket.prototype.send
...
- Do not require presence of `address` parameter to use `callback`
parameter; `address` is *always* optional
- Improve exception messaging if `address` is invalid type
- If `address` is an invalid type, guarantee a synchronously thrown
exception
- Update documentation to reflect signature changes
- Add coverage around valid, undocumented types for `address` parameter.
- Add coverage around known invalid, but uncovered, types for `address`
parameter.
PR-URL: https://github.com/nodejs/node/pull/10473
Reviewed-By: Sam Roberts <vieuxtech@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
2017-02-17 13:12:51 -08:00
Rich Trott
ef977cf8a0
doc: fix typo in dgram doc
...
There is a typographical error in the dgram documentation. Reword to
eliminate the error and increase clarity.
PR-URL: https://github.com/nodejs/node/pull/11186
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com >
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
2017-02-07 15:44:35 -08:00
Alex Jordan
89e40c1ef3
doc: correct and complete dgram's Socket.bind docs
...
`port` was listed as required, but as described in the following
paragraphs, it's actually not.
Also, note that setting `port` to `0` will also cause the OS to assign a
a random port and sync up the docs of both forms.
PR-URL: https://github.com/nodejs/node/pull/11025
Reviewed-By: Sam Roberts <vieuxtech@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
2017-01-31 12:52:59 -08:00
Matt Crummey
109bfd21d8
doc: improve rinfo object documentation
...
Provide details for fields of rinfo object of UDP message event.
PR-URL: https://github.com/nodejs/node/pull/10050
Reviewed-By: James M Snell <jasnell@gmail.com >
2016-12-27 21:31:01 -08:00
Brian White
8361c26cd5
doc: fix broken link in dgram doc
...
PR-URL: https://github.com/nodejs/node/pull/8365
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Evan Lucas <evanlucas@me.com >
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com >
2016-09-02 14:29:30 -04:00
Luigi Pinca
379d9162a2
doc: add added: information for dgram
...
PR-URL: https://github.com/nodejs/node/pull/8196
Reviewed-By: Rich Trott <rtrott@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
2016-08-25 10:56:28 -07:00
Anna Henningsen
c809b88345
doc: use blockquotes for Stability: markers
...
Use blockquotes instead of code blocks for stability markers in
the docs. Doing that:
- Makes the makers appear correctly when viewed e.g. on github.
- Allows remark-lint rules like `no-undefined-references` to work
properly (https://github.com/nodejs/node/pull/7729 ).
PR-URL: https://github.com/nodejs/node/pull/7757
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com >
Reviewed-By: Michaël Zasso <mic.besace@gmail.com >
Reviewed-By: Roman Reiss <me@silverwind.io >
2016-08-04 22:43:34 +02:00
Сковорода Никита Андреевич
a58b48bc3b
doc: various documentation formatting fixes
...
* Fix markdown code sample in releases.md, it was <a id="x.y.x></a>"
* Fix some markdown errors, e.g. in changelogs
* Fix broken defs links, e.g. in domain-postmortem.md
* Fix other broken refs, by addaleax
* Add links to some defs that were present but not linked to
* Remove dead defs
* Move defs to the bottom (one file affected)
* Add language indicators to all code blocks, using `txt` when no
specific language could be chosen
* Some minor formatting changes (spaces, ident, headings)
PR-URL: https://github.com/nodejs/node/pull/7637
Reviewed-By: Anna Henningsen <anna@addaleax.net >
Reviewed-By: Roman Reiss <me@silverwind.io >
2016-07-14 12:26:50 +03:00
Santiago Gimeno
5a641e2b6d
doc,dgram: fix addMembership documentation
...
Adding membership using `IP_ADD_MEMBERSHIP` with interface address set
to `INADDR_ANY` for `IPv4` or as an index of `0` for `IPv6` leads to
using only one interface selected by the operating system.
Fixes: https://github.com/nodejs/node/issues/1692
PR-URL: https://github.com/nodejs/node/pull/7244
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
2016-07-10 17:56:50 +02:00
Rich Trott
1ef4916ab9
doc: add added: info for dgram.*Membership()
...
Since I was doing the necessary git archaeology anyway, I took the time
to add YAML information to the docs about when `addMembership()` and
`dropMembership()` first appeared in their current forms.
PR-URL: https://github.com/nodejs/node/pull/6753
Ref: https://github.com/nodejs/node/issues/6578
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl >
2016-05-18 22:52:15 -07:00
Rich Trott
5f31b7e014
doc: add added info for dgram.setBroadcast()
...
Since I was doing the necessary git spelunking anyway, I took the time
to add the YAML information into the docs about when `setBroadcast()`
first appeared in its current form.
PR-URL: https://github.com/nodejs/node/pull/6750
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl >
Reviewed-By: James M Snell <jasnell@gmail.com >
2016-05-16 14:50:45 -07:00
Jackson Tian
e556dd3856
doc: use Buffer.from() instead of new Buffer()
...
Use new API of Buffer to developers in most documents.
PR-URL: https://github.com/nodejs/node/pull/6367
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com >
2016-04-27 13:23:41 +08:00