doc: remove spaces around slashes

Remove spaces around slash characters in documentation. This change
sometimes rewords the content where the slash construction may not be
what is called for.

PR-URL: https://github.com/nodejs/node/pull/21140
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
This commit is contained in:
Rich Trott 2018-06-04 12:32:54 -07:00
parent 25c92a9026
commit 85fe134026
8 changed files with 16 additions and 16 deletions

View File

@ -2268,7 +2268,7 @@ mode must adhere to certain restrictions when using the cipher API:
bytes (`7 ≤ N ≤ 13`). bytes (`7 ≤ N ≤ 13`).
- The length of the plaintext is limited to `2 ** (8 * (15 - N))` bytes. - The length of the plaintext is limited to `2 ** (8 * (15 - N))` bytes.
- When decrypting, the authentication tag must be set via `setAuthTag()` before - When decrypting, the authentication tag must be set via `setAuthTag()` before
specifying additional authenticated data and / or calling `update()`. specifying additional authenticated data or calling `update()`.
Otherwise, decryption will fail and `final()` will throw an error in Otherwise, decryption will fail and `final()` will throw an error in
compliance with section 2.6 of [RFC 3610][]. compliance with section 2.6 of [RFC 3610][].
- Using stream methods such as `write(data)`, `end(data)` or `pipe()` in CCM - Using stream methods such as `write(data)`, `end(data)` or `pipe()` in CCM
@ -2279,7 +2279,7 @@ mode must adhere to certain restrictions when using the cipher API:
- As CCM processes the whole message at once, `update()` can only be called - As CCM processes the whole message at once, `update()` can only be called
once. once.
- Even though calling `update()` is sufficient to encrypt/decrypt the message, - Even though calling `update()` is sufficient to encrypt/decrypt the message,
applications *must* call `final()` to compute and / or verify the applications *must* call `final()` to compute or verify the
authentication tag. authentication tag.
```js ```js

View File

@ -31,7 +31,7 @@ called.
All JavaScript errors are handled as exceptions that *immediately* generate All JavaScript errors are handled as exceptions that *immediately* generate
and throw an error using the standard JavaScript `throw` mechanism. These and throw an error using the standard JavaScript `throw` mechanism. These
are handled using the [`try / catch` construct][try-catch] provided by the are handled using the [`trycatch` construct][try-catch] provided by the
JavaScript language. JavaScript language.
```js ```js
@ -45,7 +45,7 @@ try {
``` ```
Any use of the JavaScript `throw` mechanism will raise an exception that Any use of the JavaScript `throw` mechanism will raise an exception that
*must* be handled using `try / catch` or the Node.js process will exit *must* be handled using `trycatch` or the Node.js process will exit
immediately. immediately.
With few exceptions, _Synchronous_ APIs (any blocking method that does not With few exceptions, _Synchronous_ APIs (any blocking method that does not
@ -90,7 +90,7 @@ Errors that occur within _Asynchronous APIs_ may be reported in multiple ways:
- A handful of typically asynchronous methods in the Node.js API may still - A handful of typically asynchronous methods in the Node.js API may still
use the `throw` mechanism to raise exceptions that must be handled using use the `throw` mechanism to raise exceptions that must be handled using
`try / catch`. There is no comprehensive list of such methods; please `trycatch`. There is no comprehensive list of such methods; please
refer to the documentation of each method to determine the appropriate refer to the documentation of each method to determine the appropriate
error handling mechanism required. error handling mechanism required.
@ -116,7 +116,7 @@ setImmediate(() => {
}); });
``` ```
Errors generated in this way *cannot* be intercepted using `try / catch` as Errors generated in this way *cannot* be intercepted using `trycatch` as
they are thrown *after* the calling code has already exited. they are thrown *after* the calling code has already exited.
Developers must refer to the documentation for each method to determine Developers must refer to the documentation for each method to determine
@ -149,7 +149,7 @@ fs.readFile('/some/file/that/does-not-exist', errorFirstCallback);
fs.readFile('/some/file/that/does-exist', errorFirstCallback); fs.readFile('/some/file/that/does-exist', errorFirstCallback);
``` ```
The JavaScript `try / catch` mechanism **cannot** be used to intercept errors The JavaScript `trycatch` mechanism **cannot** be used to intercept errors
generated by asynchronous APIs. A common mistake for beginners is to try to generated by asynchronous APIs. A common mistake for beginners is to try to
use `throw` inside an error-first callback: use `throw` inside an error-first callback:

View File

@ -367,7 +367,7 @@ added: v8.0.0
Destroy the stream, and emit the passed `'error'` and a `'close'` event. Destroy the stream, and emit the passed `'error'` and a `'close'` event.
After this call, the writable stream has ended and subsequent calls After this call, the writable stream has ended and subsequent calls
to `write()` / `end()` will give an `ERR_STREAM_DESTROYED` error. to `write()` or `end()` will result in an `ERR_STREAM_DESTROYED` error.
Implementors should not override this method, Implementors should not override this method,
but instead implement [`writable._destroy()`][writable-_destroy]. but instead implement [`writable._destroy()`][writable-_destroy].