From c2791dcd9c915dc0afedb313ac92d6517ae7b6ca Mon Sep 17 00:00:00 2001 From: Vse Mozhet Byt Date: Mon, 23 Sep 2019 16:57:03 +0300 Subject: [PATCH] doc: fix some recent nits PR-URL: https://github.com/nodejs/node/pull/29670 Reviewed-By: Colin Ihrig Reviewed-By: Anna Henningsen Reviewed-By: Yongsheng Zhang Reviewed-By: Ruben Bridgewater Reviewed-By: Luigi Pinca Reviewed-By: James M Snell --- doc/api/events.md | 5 +++-- doc/api/fs.md | 2 +- doc/api/process.md | 2 +- doc/api/tls.md | 26 +++++++++++++------------- 4 files changed, 18 insertions(+), 17 deletions(-) diff --git a/doc/api/events.md b/doc/api/events.md index 8d409582329c14..9b22d33e12caa0 100644 --- a/doc/api/events.md +++ b/doc/api/events.md @@ -709,7 +709,7 @@ The `Promise` will resolve with an array of all the arguments emitted to the given event. This method is intentionally generic and works with the web platform -[EventTarget](WHATWG-EventTarget) interface, which has no special +[EventTarget][WHATWG-EventTarget] interface, which has no special `'error'` event semantics and does not listen to the `'error'` event. ```js @@ -739,7 +739,8 @@ async function run() { run(); ``` -[WHATWG-EventTarget](https://dom.spec.whatwg.org/#interface-eventtarget) + +[WHATWG-EventTarget]: https://dom.spec.whatwg.org/#interface-eventtarget [`--trace-warnings`]: cli.html#cli_trace_warnings [`EventEmitter.defaultMaxListeners`]: #events_eventemitter_defaultmaxlisteners [`domain`]: domain.html diff --git a/doc/api/fs.md b/doc/api/fs.md index 2b6e93860de7a2..7ea6835387719b 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -4253,7 +4253,7 @@ then resolves the `Promise` with no arguments upon success. This function does not work on AIX versions before 7.1, it will resolve the `Promise` with an error using code `UV_ENOSYS`. -#### filehandle.write(buffer, offset, length, position) +#### filehandle.write(buffer[, offset[, length[, position]]]) diff --git a/doc/api/process.md b/doc/api/process.md index 57b4eae02b2faa..bf632a199000ce 100644 --- a/doc/api/process.md +++ b/doc/api/process.md @@ -2244,7 +2244,7 @@ undefined true > process.emitWarning('test', 'DeprecationWarning'); Thrown: -{ [DeprecationWarning: test] name: 'DeprecationWarning' } +[DeprecationWarning: test] { name: 'DeprecationWarning' } ``` ## process.title diff --git a/doc/api/tls.md b/doc/api/tls.md index 24d826191f675a..68cf5e36bc9f40 100644 --- a/doc/api/tls.md +++ b/doc/api/tls.md @@ -842,18 +842,6 @@ See [SSL_CIPHER_get_name](https://www.openssl.org/docs/man1.1.1/man3/SSL_CIPHER_get_name.html) for more information. -### tlsSocket.getSharedSigalgs() - - -* Returns: {Array} List of signature algorithms shared between the server and -the client in the order of decreasing preference. - -See -[SSL_get_shared_sigalgs](https://www.openssl.org/docs/man1.1.1/man3/SSL_get_shared_sigalgs.html) -for more information. - ### tlsSocket.getEphemeralKeyInfo() + +* Returns: {Array} List of signature algorithms shared between the server and +the client in the order of decreasing preference. + +See +[SSL_get_shared_sigalgs](https://www.openssl.org/docs/man1.1.1/man3/SSL_get_shared_sigalgs.html) +for more information. + ### tlsSocket.getTLSTicket()