FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

doc: remove spaces around slashes · nodejs/node@2c4f80f · GitHub

/ node Public

Commit 2c4f80f

Browse files
Trott
authored and
targos
committed
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: #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>
1 parent 72e7e1d commit 2c4f80f

8 files changed

Lines changed: 16 additions & 16 deletions

File tree

‎doc/api/assert.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1083,7 +1083,7 @@ validating against a string property. See below for examples.
10831083
If specified, `message` will be the message provided by the `AssertionError` if
10841084
the block fails to throw.
10851085

1086-
Custom validation object / error instance:
1086+
Custom validation object/error instance:
10871087

10881088
```js
10891089
const err = new TypeError('Wrong value');

‎doc/api/crypto.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2263,7 +2263,7 @@ mode must adhere to certain restrictions when using the cipher API:
22632263
bytes (`7 ≤ N ≤ 13`).
22642264
- The length of the plaintext is limited to `2 ** (8 * (15 - N))` bytes.
22652265
- When decrypting, the authentication tag must be set via `setAuthTag()` before
2266-
specifying additional authenticated data and / or calling `update()`.
2266+
specifying additional authenticated data or calling `update()`.
22672267
Otherwise, decryption will fail and `final()` will throw an error in
22682268
compliance with section 2.6 of [RFC 3610][].
22692269
- Using stream methods such as `write(data)`, `end(data)` or `pipe()` in CCM
@@ -2273,8 +2273,8 @@ mode must adhere to certain restrictions when using the cipher API:
22732273
option. This is not necessary if no AAD is used.
22742274
- As CCM processes the whole message at once, `update()` can only be called
22752275
once.
2276-
- Even though calling `update()` is sufficient to encrypt / decrypt the message,
2277-
applications *must* call `final()` to compute and / or verify the
2276+
- Even though calling `update()` is sufficient to encrypt/decrypt the message,
2277+
applications *must* call `final()` to compute or verify the
22782278
authentication tag.
22792279

22802280
```js

‎doc/api/dgram.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# UDP / Datagram Sockets
1+
# UDP/Datagram Sockets
22

33
<!--introduced_in=v0.10.0-->
44

‎doc/api/dns.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -499,8 +499,8 @@ will be present on the object:
499499

500500
| Type | Properties |
501501
|------|------------|
502-
| `'A'` | `address` / `ttl` |
503-
| `'AAAA'` | `address` / `ttl` |
502+
| `'A'` | `address`/`ttl` |
503+
| `'AAAA'` | `address`/`ttl` |
504504
| `'CNAME'` | `value` |
505505
| `'MX'` | Refer to [`dns.resolveMx()`][] |
506506
| `'NAPTR'` | Refer to [`dns.resolveNaptr()`][] |

‎doc/api/errors.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ called.
3131

3232
All JavaScript errors are handled as exceptions that *immediately* generate
3333
and throw an error using the standard JavaScript `throw` mechanism. These
34-
are handled using the [`try / catch` construct][try-catch] provided by the
34+
are handled using the [`try…catch` construct][try-catch] provided by the
3535
JavaScript language.
3636

3737
```js
@@ -45,7 +45,7 @@ try {
4545
```
4646

4747
Any use of the JavaScript `throw` mechanism will raise an exception that
48-
*must* be handled using `try / catch` or the Node.js process will exit
48+
*must* be handled using `try…catch` or the Node.js process will exit
4949
immediately.
5050

5151
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:
9090

9191
- A handful of typically asynchronous methods in the Node.js API may still
9292
use the `throw` mechanism to raise exceptions that must be handled using
93-
`try / catch`. There is no comprehensive list of such methods; please
93+
`try…catch`. There is no comprehensive list of such methods; please
9494
refer to the documentation of each method to determine the appropriate
9595
error handling mechanism required.
9696

@@ -116,7 +116,7 @@ setImmediate(() => {
116116
});
117117
```
118118

119-
Errors generated in this way *cannot* be intercepted using `try / catch` as
119+
Errors generated in this way *cannot* be intercepted using `try…catch` as
120120
they are thrown *after* the calling code has already exited.
121121

122122
Developers must refer to the documentation for each method to determine
@@ -149,7 +149,7 @@ fs.readFile('/some/file/that/does-not-exist', errorFirstCallback);
149149
fs.readFile('/some/file/that/does-exist', errorFirstCallback);
150150
```
151151

152-
The JavaScript `try / catch` mechanism **cannot** be used to intercept errors
152+
The JavaScript `try…catch` mechanism **cannot** be used to intercept errors
153153
generated by asynchronous APIs. A common mistake for beginners is to try to
154154
use `throw` inside an error-first callback:
155155

@@ -648,7 +648,7 @@ Used when a child process is being forked without specifying an IPC channel.
648648
### ERR_CHILD_PROCESS_STDIO_MAXBUFFER
649649

650650
Used when the main process is trying to read data from the child process's
651-
STDERR / STDOUT, and the data's length is longer than the `maxBuffer` option.
651+
STDERR/STDOUT, and the data's length is longer than the `maxBuffer` option.
652652

653653
<a id="ERR_CLOSED_MESSAGE_PORT"></a>
654654
### ERR_CLOSED_MESSAGE_PORT

‎doc/api/intl.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ To control how ICU is used in Node.js, four `configure` options are available
3636
during compilation. Additional details on how to compile Node.js are documented
3737
in [BUILDING.md][].
3838

39-
- `--with-intl=none` / `--without-intl`
39+
- `--with-intl=none`/`--without-intl`
4040
- `--with-intl=system-icu`
4141
- `--with-intl=small-icu` (default)
4242
- `--with-intl=full-icu`

‎doc/api/net.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,7 @@ called. Otherwise, an `ERR_SERVER_ALREADY_LISTEN` error will be thrown.
213213

214214
One of the most common errors raised when listening is `EADDRINUSE`.
215215
This happens when another server is already listening on the requested
216-
`port` / `path` / `handle`. One way to handle this would be to retry
216+
`port`/`path`/`handle`. One way to handle this would be to retry
217217
after a certain amount of time:
218218

219219
```js

‎doc/api/stream.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -367,7 +367,7 @@ added: v8.0.0
367367

368368
Destroy the stream, and emit the passed `'error'` and a `'close'` event.
369369
After this call, the writable stream has ended and subsequent calls
370-
to `write()` / `end()` will give an `ERR_STREAM_DESTROYED` error.
370+
to `write()` or `end()` will result in an `ERR_STREAM_DESTROYED` error.
371371
Implementors should not override this method,
372372
but instead implement [`writable._destroy()`][writable-_destroy].
373373

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL