node/doc/api
Rich Trott f0a33d99ec doc: simplify and correct example descriptions in net.md
Instead of indicating that examples show lines to change in previous
examples, present the examples as standalone items. They suffice on
their own.

In the first of these, it says to change "the second line" of a previous
example, but if it were literally changed to the provided line, it would
result in a syntax error.

In the second of these, it gives the wrong line to change.

All of this is unnecessary and probably makes the examples harder to
follow. So simplify and treat each one as a separate example.

PR-URL: https://github.com/nodejs/node/pull/32451
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2020-03-25 23:15:20 -07:00
..
addons.md doc: remove personal pronoun usage in addons.md 2020-03-09 19:47:24 -07:00
assert.md doc: update assert.rejects() docs with a validation function example 2020-02-24 03:49:12 -08:00
async_hooks.md 2020-03-11 Version 13.11.0 (Current) 2020-03-11 23:54:53 -04:00
buffer.md doc: improve Buffer documentation 2020-03-11 17:07:39 +01:00
child_process.md doc: clear up child_process command resolution 2020-03-11 17:36:17 +01:00
cli.md cli: allow --huge-max-old-generation-size in NODE_OPTIONS 2020-03-20 14:22:18 +01:00
cluster.md doc,cluster: use code markup/markdown in headers 2019-12-26 21:37:25 -08:00
console.md doc,console: use code markup/markdown in headers 2019-12-26 21:37:26 -08:00
crypto.md doc,crypto: re-document oaepLabel option 2020-02-23 01:25:40 -04:00
debugger.md doc: reword possessive form of Node.js in debugger.md 2020-02-17 17:32:53 -08:00
deprecations.md http: move OutboundMessage.prototype.flush to EOL 2020-02-24 08:46:37 -08:00
dgram.md doc: standardize on "host name" in dgram.md 2020-01-14 10:17:19 -08:00
dns.md doc: improve dns introduction 2019-12-27 06:14:41 -08:00
documentation.md doc: add link to sem-ver info 2020-03-02 04:07:33 +00:00
domain.md doc,domain: use code markup/markdown in headers 2019-12-26 21:39:24 -08:00
embedding.md doc: add basic embedding example documentation 2020-03-21 10:58:25 +01:00
errors.md lib: add option to disable __proto__ 2020-03-18 10:22:42 -07:00
esm.md doc: fix lint warning in doc/api/esm.md 2020-03-24 14:35:35 -04:00
events.md 2020-01-07, Version v13.6.0 (Current) 2020-01-08 00:10:43 +01:00
fs.md doc: expand fs.watch caveats 2020-03-13 09:55:35 +01:00
globals.md doc: use code markup/markdown in headers in globals documentation 2019-12-26 21:39:26 -08:00
http2.md doc,test: add server.timeout property to http2 public API 2020-03-11 19:33:48 +01:00
http.md http: fix socket re-use races 2020-03-07 20:51:12 +01:00
https.md doc: fix typos in doc/api/https.md 2020-02-16 16:58:39 +01:00
index.md doc: add basic embedding example documentation 2020-03-21 10:58:25 +01:00
inspector.md doc,inspector: use code markup/markdown in headers 2019-12-26 21:39:27 -08:00
intl.md tools: support full-icu by default 2019-10-03 15:21:26 -07:00
modules.md doc: include the error type in the request.resolve doc 2020-03-11 17:41:54 +01:00
n-api.md doc: complete n-api version matrix 2020-03-18 16:03:01 -07:00
net.md doc: simplify and correct example descriptions in net.md 2020-03-25 23:15:20 -07:00
os.md doc: fix os.version() Windows API 2020-03-12 20:43:34 -04:00
path.md doc: remove em dashes 2020-03-05 22:25:42 -08:00
perf_hooks.md 2020-02-18, Version 13.9.0 (Current) 2020-02-18 12:40:21 -08:00
policy.md doc: remove personal pronoun usage in policy.md 2020-03-09 19:47:29 -07:00
process.md src,cli: support compact (one-line) JSON reports 2020-03-17 08:42:41 -07:00
punycode.md doc,punycode: use code markup/markdown in headers 2019-12-26 21:39:30 -08:00
querystring.md doc,querystring: use code markup/markdown in headers 2019-12-26 21:39:30 -08:00
readline.md doc: updated YAML version representation in readline.md 2020-02-25 13:53:22 -08:00
repl.md doc: reword possessive form of Node.js in repl.md 2020-02-12 00:20:37 -08:00
report.md src,cli: support compact (one-line) JSON reports 2020-03-17 08:42:41 -07:00
stream.md 2020-03-04 Version 13.10.0 (Current) 2020-03-04 09:53:11 -08:00
string_decoder.md doc: add support encoding link on string_decoder.md 2020-03-11 17:06:13 +01:00
synopsis.md doc: move Usage and Example to same header level 2019-07-09 19:45:20 -07:00
timers.md doc,timers: use code markup/markdown in headers 2019-12-26 21:39:32 -08:00
tls.md 2020-03-04 Version 13.10.0 (Current) 2020-03-04 09:53:11 -08:00
tracing.md doc: remove dashes 2019-10-26 08:39:41 -07:00
tty.md doc,tty: use code markup/markdown in headers 2019-12-26 21:39:33 -08:00
url.md doc: remove em dashes 2020-03-05 22:25:42 -08:00
util.md src: remove deprecated wasm type check 2020-03-18 16:37:19 -07:00
v8.md doc: clarify that v8.serialize() is not deterministic 2020-01-30 16:35:47 -08:00
vm.md doc: improve wording in vm.md 2020-03-24 10:24:37 -07:00
wasi.md wasi: add returnOnExit option 2020-03-08 11:05:23 -04:00
worker_threads.md worker: allow URL in Worker constructor 2020-03-13 10:50:30 +01:00
zlib.md doc: update zlib doc 2020-02-26 16:56:16 -08:00