0
0
mirror of https://github.com/nodejs/node.git synced 2024-12-01 16:10:02 +01:00
nodejs/doc/api
Rich Trott 55d9833ebf doc: remove default parameter value from header
In the docs, we specify the default value of function parameters in the
list below the header. There is one exception where we use default
parameter notation. Change that instance to be like the rest of the docs
instead.

I rather like the default parameter notation, and I get why we didn't
use it to begin with. (The notation didn't exist in JavaScript at the
time.) I wouldn't mind switching to it, but that would result in big
churn. That can be a separate topic of discussion. For now, though,
let's get the docs consistent.

PR-URL: https://github.com/nodejs/node/pull/33752
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
2020-06-07 11:10:45 -07:00
..
addons.md
assert.md
async_hooks.md 2020-05-26, Version 12.17.0 'Erbium' (LTS) 2020-05-26 15:55:39 +02:00
buffer.md doc: improve buffer.md a tiny bit 2020-05-30 04:28:53 +02:00
child_process.md net: remove long deprecated server.connections property 2020-06-01 08:38:00 -07:00
cli.md lib: unflag AbortController 2020-06-05 12:21:49 -07:00
cluster.md doc: remove default parameter value from header 2020-06-07 11:10:45 -07:00
console.md 2020-05-26, Version 12.17.0 'Erbium' (LTS) 2020-05-26 15:55:39 +02:00
crypto.md 2020-05-26, Version 12.17.0 'Erbium' (LTS) 2020-05-26 15:55:39 +02:00
debugger.md
deprecations.md doc: fix deprecation "End-of-Life" capitalization 2020-06-02 17:19:42 -04:00
dgram.md
dns.md dns: make dns.Resolver timeout configurable 2020-06-01 08:07:59 -07:00
documentation.md
domain.md
embedding.md
errors.md doc: update ``txt `fandamental and ``raw code blocks 2020-05-30 03:43:39 +02:00
esm.md module: remove dynamicInstantiate loader hook 2020-05-27 16:38:38 -07:00
events.md doc: use consistent Default: in events 2020-06-02 17:16:52 -04:00
fs.md fs: support util.promisify for fs.readv 2020-05-30 10:17:31 -07:00
globals.md lib: unflag AbortController 2020-06-05 12:21:49 -07:00
http2.md 2020-06-02, Version 10.21.0 'Dubnium' (LTS) 2020-06-02 20:35:52 +02:00
http.md doc: update ``txt `fandamental and ``raw code blocks 2020-05-30 03:43:39 +02:00
https.md
index.md
inspector.md
intl.md
modules.md doc: update ``txt `fandamental and ``raw code blocks 2020-05-30 03:43:39 +02:00
n-api.md 2020-05-26, Version 12.17.0 'Erbium' (LTS) 2020-05-26 15:55:39 +02:00
net.md net: remove long deprecated server.connections property 2020-06-01 08:38:00 -07:00
os.md 2020-05-26, Version 12.17.0 'Erbium' (LTS) 2020-05-26 15:55:39 +02:00
path.md
perf_hooks.md 2020-05-26, Version 12.17.0 'Erbium' (LTS) 2020-05-26 15:55:39 +02:00
policy.md
process.md doc: outline when origin is set to unhandledRejection 2020-05-30 04:21:21 +02:00
punycode.md
querystring.md
readline.md
repl.md 2020-05-26, Version 12.17.0 'Erbium' (LTS) 2020-05-26 15:55:39 +02:00
report.md doc: update ``txt `fandamental and ``raw code blocks 2020-05-30 03:43:39 +02:00
stream.md doc: normalize JavaScript code block info strings 2020-05-30 04:22:04 +02:00
string_decoder.md
synopsis.md
timers.md
tls.md net: remove long deprecated server.connections property 2020-06-01 08:38:00 -07:00
tracing.md doc: update ``txt `fandamental and ``raw code blocks 2020-05-30 03:43:39 +02:00
tty.md
url.md url: remove gopher from special schemes 2020-06-06 11:11:02 +02:00
util.md doc: update ``txt `fandamental and ``raw code blocks 2020-05-30 03:43:39 +02:00
v8.md
vm.md 2020-05-26, Version 12.17.0 'Erbium' (LTS) 2020-05-26 15:55:39 +02:00
wasi.md wasi: allow WASI stdio to be configured 2020-05-30 04:28:02 +02:00
worker_threads.md 2020-05-26, Version 12.17.0 'Erbium' (LTS) 2020-05-26 15:55:39 +02:00
zlib.md