jiangcuo/node
1
0
Fork 0
mirror of https://github.com/nodejs/node.git synced 2025-05-08 14:27:07 +00:00
Code Issues Actions 12 Packages Projects Releases Wiki Activity
55d9833ebf
node/doc/api
History
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 doc: normalize C++ code block info strings 2020-05-23 17:21:20 +02:00
assert.md 2020-05-05, Version 14.2.0 (Current) 2020-05-05 20:24:37 +02:00
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 doc: reword possessive form of Node.js in debugger.md 2020-02-17 17:32:53 -08:00
deprecations.md doc: fix deprecation "End-of-Life" capitalization 2020-06-02 17:19:42 -04:00
dgram.md doc: fix LTS replaceme tags 2020-04-28 15:23:46 +02:00
dns.md dns: make dns.Resolver timeout configurable 2020-06-01 08:07:59 -07: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: normalize C++ code block info strings 2020-05-23 17:21:20 +02:00
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 2020-04-29, Version 13.14.0 (Current) 2020-04-30 00:24:31 +02: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 doc: normalize shell code block info strings 2020-05-25 19:12:38 +02:00
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 doc: fixed a grammatical error in path.md 2020-05-23 17:13:28 +02:00
perf_hooks.md 2020-05-26, Version 12.17.0 'Erbium' (LTS) 2020-05-26 15:55:39 +02:00
policy.md doc: normalize Bash code block info strings 2020-05-25 19:08:45 +02:00
process.md doc: outline when origin is set to unhandledRejection 2020-05-30 04:21:21 +02: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: fix readline key binding documentation 2020-05-20 17:05:01 +02:00
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 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 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 doc: normalize Bash code block info strings 2020-05-25 19:08:45 +02:00
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 doc: clarify that v8.serialize() is not deterministic 2020-01-30 16:35:47 -08:00
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 doc: fix LTS replaceme tags 2020-04-28 15:23:46 +02:00