summaryrefslogtreecommitdiff
path: root/doc/api
diff options
context:
space:
mode:
authorRich Trott <rtrott@gmail.com>2018-06-04 12:32:54 -0700
committerRich Trott <rtrott@gmail.com>2018-06-06 21:23:00 -0700
commit85fe13402659a174773bfecebac6e8bb5164f572 (patch)
tree11e64ad1b52d37039d517143e10e91a23aed1fc6 /doc/api
parent25c92a90262e4bdaa97999f5fade56a9551701c9 (diff)
downloadandroid-node-v8-85fe13402659a174773bfecebac6e8bb5164f572.tar.gz
android-node-v8-85fe13402659a174773bfecebac6e8bb5164f572.tar.bz2
android-node-v8-85fe13402659a174773bfecebac6e8bb5164f572.zip
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>
Diffstat (limited to 'doc/api')
-rw-r--r--doc/api/assert.md2
-rw-r--r--doc/api/crypto.md6
-rw-r--r--doc/api/dgram.md2
-rw-r--r--doc/api/dns.md4
-rw-r--r--doc/api/errors.md12
-rw-r--r--doc/api/intl.md2
-rw-r--r--doc/api/net.md2
-rw-r--r--doc/api/stream.md2
8 files changed, 16 insertions, 16 deletions
diff --git a/doc/api/assert.md b/doc/api/assert.md
index 45132eec85..57fcc14de2 100644
--- a/doc/api/assert.md
+++ b/doc/api/assert.md
@@ -1083,7 +1083,7 @@ validating against a string property. See below for examples.
If specified, `message` will be the message provided by the `AssertionError` if
the block fails to throw.
-Custom validation object / error instance:
+Custom validation object/error instance:
```js
const err = new TypeError('Wrong value');
diff --git a/doc/api/crypto.md b/doc/api/crypto.md
index ce5fe6a6d1..a535f55ea6 100644
--- a/doc/api/crypto.md
+++ b/doc/api/crypto.md
@@ -2268,7 +2268,7 @@ mode must adhere to certain restrictions when using the cipher API:
bytes (`7 ≤ N ≤ 13`).
- The length of the plaintext is limited to `2 ** (8 * (15 - N))` bytes.
- 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
compliance with section 2.6 of [RFC 3610][].
- Using stream methods such as `write(data)`, `end(data)` or `pipe()` in CCM
@@ -2278,8 +2278,8 @@ mode must adhere to certain restrictions when using the cipher API:
option. This is not necessary if no AAD is used.
- As CCM processes the whole message at once, `update()` can only be called
once.
-- Even though calling `update()` is sufficient to encrypt / decrypt the message,
- applications *must* call `final()` to compute and / or verify the
+- Even though calling `update()` is sufficient to encrypt/decrypt the message,
+ applications *must* call `final()` to compute or verify the
authentication tag.
```js
diff --git a/doc/api/dgram.md b/doc/api/dgram.md
index cd3e1de15a..f4db86d5ea 100644
--- a/doc/api/dgram.md
+++ b/doc/api/dgram.md
@@ -1,4 +1,4 @@
-# UDP / Datagram Sockets
+# UDP/Datagram Sockets
<!--introduced_in=v0.10.0-->
diff --git a/doc/api/dns.md b/doc/api/dns.md
index 93f91a6e35..8d47556d7c 100644
--- a/doc/api/dns.md
+++ b/doc/api/dns.md
@@ -499,8 +499,8 @@ will be present on the object:
| Type | Properties |
|------|------------|
-| `'A'` | `address` / `ttl` |
-| `'AAAA'` | `address` / `ttl` |
+| `'A'` | `address`/`ttl` |
+| `'AAAA'` | `address`/`ttl` |
| `'CNAME'` | `value` |
| `'MX'` | Refer to [`dns.resolveMx()`][] |
| `'NAPTR'` | Refer to [`dns.resolveNaptr()`][] |
diff --git a/doc/api/errors.md b/doc/api/errors.md
index 855eac357a..e5a9489983 100644
--- a/doc/api/errors.md
+++ b/doc/api/errors.md
@@ -31,7 +31,7 @@ called.
All JavaScript errors are handled as exceptions that *immediately* generate
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 [`try…catch` construct][try-catch] provided by the
JavaScript language.
```js
@@ -45,7 +45,7 @@ try {
```
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 `try…catch` or the Node.js process will exit
immediately.
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
use the `throw` mechanism to raise exceptions that must be handled using
- `try / catch`. There is no comprehensive list of such methods; please
+ `try…catch`. There is no comprehensive list of such methods; please
refer to the documentation of each method to determine the appropriate
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 `try…catch` as
they are thrown *after* the calling code has already exited.
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);
```
-The JavaScript `try / catch` mechanism **cannot** be used to intercept errors
+The JavaScript `try…catch` mechanism **cannot** be used to intercept errors
generated by asynchronous APIs. A common mistake for beginners is to try to
use `throw` inside an error-first callback:
@@ -648,7 +648,7 @@ Used when a child process is being forked without specifying an IPC channel.
### ERR_CHILD_PROCESS_STDIO_MAXBUFFER
Used when the main process is trying to read data from the child process's
-STDERR / STDOUT, and the data's length is longer than the `maxBuffer` option.
+STDERR/STDOUT, and the data's length is longer than the `maxBuffer` option.
<a id="ERR_CLOSED_MESSAGE_PORT"></a>
### ERR_CLOSED_MESSAGE_PORT
diff --git a/doc/api/intl.md b/doc/api/intl.md
index fe5c4ef9d0..fc10bf9dda 100644
--- a/doc/api/intl.md
+++ b/doc/api/intl.md
@@ -36,7 +36,7 @@ To control how ICU is used in Node.js, four `configure` options are available
during compilation. Additional details on how to compile Node.js are documented
in [BUILDING.md][].
-- `--with-intl=none` / `--without-intl`
+- `--with-intl=none`/`--without-intl`
- `--with-intl=system-icu`
- `--with-intl=small-icu` (default)
- `--with-intl=full-icu`
diff --git a/doc/api/net.md b/doc/api/net.md
index e48bdc1eaa..f1e41b46c4 100644
--- a/doc/api/net.md
+++ b/doc/api/net.md
@@ -213,7 +213,7 @@ called. Otherwise, an `ERR_SERVER_ALREADY_LISTEN` error will be thrown.
One of the most common errors raised when listening is `EADDRINUSE`.
This happens when another server is already listening on the requested
-`port` / `path` / `handle`. One way to handle this would be to retry
+`port`/`path`/`handle`. One way to handle this would be to retry
after a certain amount of time:
```js
diff --git a/doc/api/stream.md b/doc/api/stream.md
index 483aec1b70..014b2f68b3 100644
--- a/doc/api/stream.md
+++ b/doc/api/stream.md
@@ -367,7 +367,7 @@ added: v8.0.0
Destroy the stream, and emit the passed `'error'` and a `'close'` event.
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,
but instead implement [`writable._destroy()`][writable-_destroy].