From e4854de18c49f59f3ee8341822bb4f7e02bd6c7b Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Sat, 6 Jun 2020 22:06:34 -0700 Subject: [PATCH] doc: standardize constructor doc header layout Our docs use a mixture of _Constructor: `new Fhqwhgads()`_ in some headers and only _`new Fhqwhgads()`_ in other headers. The latter is about three times as common, so let's standardize on that. PR-URL: https://github.com/nodejs/node/pull/33781 Reviewed-By: Anna Henningsen Reviewed-By: Luigi Pinca Reviewed-By: Evan Lucas Reviewed-By: Benjamin Gruenbaum --- doc/api/crypto.md | 2 +- doc/api/errors.md | 4 ++-- doc/api/http.md | 2 +- doc/api/https.md | 2 +- doc/api/inspector.md | 2 +- doc/api/stream.md | 4 ++-- doc/api/url.md | 12 ++++++------ doc/api/v8.md | 2 +- doc/api/vm.md | 6 +++--- 9 files changed, 18 insertions(+), 18 deletions(-) diff --git a/doc/api/crypto.md b/doc/api/crypto.md index 3076bdaa5e5028..72982ecbb57651 100644 --- a/doc/api/crypto.md +++ b/doc/api/crypto.md @@ -3496,7 +3496,7 @@ the `crypto`, `tls`, and `https` modules and are generally specific to OpenSSL. [`keyObject.export()`]: #crypto_keyobject_export_options [`sign.sign()`]: #crypto_sign_sign_privatekey_outputencoding [`sign.update()`]: #crypto_sign_update_data_inputencoding -[`stream.Writable` options]: stream.html#stream_constructor_new_stream_writable_options +[`stream.Writable` options]: stream.html#stream_new_stream_writable_options [`stream.transform` options]: stream.html#stream_new_stream_transform_options [`util.promisify()`]: util.html#util_util_promisify_original [`verify.update()`]: #crypto_verify_update_data_inputencoding diff --git a/doc/api/errors.md b/doc/api/errors.md index 6901f02ea60280..d9fd4cd4af2a90 100644 --- a/doc/api/errors.md +++ b/doc/api/errors.md @@ -2556,8 +2556,8 @@ such as `process.stdout.on('data')`. [`https`]: https.html [`libuv Error handling`]: http://docs.libuv.org/en/v1.x/errors.html [`net`]: net.html -[`new URL(input)`]: url.html#url_constructor_new_url_input_base -[`new URLSearchParams(iterable)`]: url.html#url_constructor_new_urlsearchparams_iterable +[`new URL(input)`]: url.html#url_new_url_input_base +[`new URLSearchParams(iterable)`]: url.html#url_new_urlsearchparams_iterable [`process.on('exit')`]: process.html#Event:-`'exit'` [`process.send()`]: process.html#process_process_send_message_sendhandle_options_callback [`process.setUncaughtExceptionCaptureCallback()`]: process.html#process_process_setuncaughtexceptioncapturecallback_fn diff --git a/doc/api/http.md b/doc/api/http.md index 57b5d53a1db0ef..fc79f432f7fb11 100644 --- a/doc/api/http.md +++ b/doc/api/http.md @@ -2383,7 +2383,7 @@ not abort the request or do anything besides add a `'timeout'` event. [`net.Server`]: net.html#net_class_net_server [`net.Socket`]: net.html#net_class_net_socket [`net.createConnection()`]: net.html#net_net_createconnection_options_connectlistener -[`new URL()`]: url.html#url_constructor_new_url_input_base +[`new URL()`]: url.html#url_new_url_input_base [`removeHeader(name)`]: #http_request_removeheader_name [`request.end()`]: #http_request_end_data_encoding_callback [`request.flushHeaders()`]: #http_request_flushheaders diff --git a/doc/api/https.md b/doc/api/https.md index c685b3fe636c5a..3d6a86d7167feb 100644 --- a/doc/api/https.md +++ b/doc/api/https.md @@ -447,7 +447,7 @@ headers: max-age=0; pin-sha256="WoiWRyIOVNa9ihaBciRSC7XHjliYS9VwUGOIud4PB18="; p [`https.Agent`]: #https_class_https_agent [`https.request()`]: #https_https_request_options_callback [`net.Server`]: net.html#net_class_net_server -[`new URL()`]: url.html#url_constructor_new_url_input_base +[`new URL()`]: url.html#url_new_url_input_base [`server.listen()`]: net.html#net_server_listen [`tls.connect()`]: tls.html#tls_tls_connect_options_callback [`tls.createSecureContext()`]: tls.html#tls_tls_createsecurecontext_options diff --git a/doc/api/inspector.md b/doc/api/inspector.md index eeab3799cec325..4f9501a5f861a7 100644 --- a/doc/api/inspector.md +++ b/doc/api/inspector.md @@ -84,7 +84,7 @@ An exception will be thrown if there is no active inspector. The `inspector.Session` is used for dispatching messages to the V8 inspector back-end and receiving message responses and notifications. -### Constructor: `new inspector.Session()` +### `new inspector.Session()` diff --git a/doc/api/stream.md b/doc/api/stream.md index b8c864c7913cd0..e4d79623f2724e 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -1739,7 +1739,7 @@ Custom `Writable` streams *must* call the `new stream.Writable([options])` constructor and implement the `writable._write()` and/or `writable._writev()` method. -#### Constructor: `new stream.Writable([options])` +#### `new stream.Writable([options])`