doc: fix some recent nits

PR-URL: #29670 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Yongsheng Zhang <zyszys98@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
nodejs · Sep 27, 2019 · 008a1f6 · 008a1f6
1 parent f81bef5
commit 008a1f6
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 17 deletions.
diff --git 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
@@ -4243,7 +4243,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]]])
 <!-- YAML
 added: v10.0.0
 -->

diff --git 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
@@ -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()
-<!-- YAML
-added: v12.11.0
--->
-
-* 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()
 <!-- YAML
 added: v5.0.0
@@ -1049,6 +1037,18 @@ See [Session Resumption][] for more information.
 Note: `getSession()` works only for TLSv1.2 and below. For TLSv1.3, applications
 must use the [`'session'`][] event (it also works for TLSv1.2 and below).
 
+### tlsSocket.getSharedSigalgs()
+<!-- YAML
+added: v12.11.0
+-->
+
+* 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()
 <!-- YAML
 added: v0.11.4
@@ -1422,7 +1422,7 @@ changes:
     order as their private keys in `key`. If the intermediate certificates are
     not provided, the peer will not be able to validate the certificate, and the
     handshake will fail.
-  * `sigalgs` {string}` Colon-separated list of supported signature algorithms.
+  * `sigalgs` {string} Colon-separated list of supported signature algorithms.
     The list can contain digest algorithms (`SHA256`, `MD5` etc.), public key
     algorithms (`RSA-PSS`, `ECDSA` etc.), combination of both (e.g
     'RSA+SHA384') or TLS v1.3 scheme names (e.g. `rsa_pss_pss_sha512`).