Skip to content

Commit 05f5b3e

Browse files
TrottBethGriggs
authored andcommittedMar 9, 2020
doc: remove em dashes
Our documentation uses em dashes inconsistently. They are treated inconsistently typographically too. (For example, they are sometimes surrounded by spaces and sometimes not.) They are also often confused with ordinary hyphens such as in the CHANGELOG, where they are inadvertently mixed together in a single list. The difference is not obvious in the raw markdown but is very noticeable when rendered, appearing to be a typographical error (which it in fact is). The em dash is never needed. There are always alternatives. Remove em dashes entirely. PR-URL: #32080 Backport-PR-URL: #32149 Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
1 parent b164a2e commit 05f5b3e

File tree

12 files changed

+29
-29
lines changed

12 files changed

+29
-29
lines changed
 

‎CHANGELOG.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,18 @@
22

33
Select a Node.js version below to view the changelog history:
44

5-
* [Node.js 12](doc/changelogs/CHANGELOG_V12.md) - **Current**
6-
* [Node.js 11](doc/changelogs/CHANGELOG_V11.md) - Current
7-
* [Node.js 10](doc/changelogs/CHANGELOG_V10.md) **Long Term Support**
8-
* [Node.js 9](doc/changelogs/CHANGELOG_V9.md) End-of-Life
9-
* [Node.js 8](doc/changelogs/CHANGELOG_V8.md) — Long Term Support
10-
* [Node.js 7](doc/changelogs/CHANGELOG_V7.md) End-of-Life
11-
* [Node.js 6](doc/changelogs/CHANGELOG_V6.md) — Long Term Support
12-
* [Node.js 5](doc/changelogs/CHANGELOG_V5.md) End-of-Life
13-
* [Node.js 4](doc/changelogs/CHANGELOG_V4.md) End-of-Life
14-
* [io.js](doc/changelogs/CHANGELOG_IOJS.md) End-of-Life
15-
* [Node.js 0.12](doc/changelogs/CHANGELOG_V012.md) End-of-Life
16-
* [Node.js 0.10](doc/changelogs/CHANGELOG_V010.md) End-of-Life
5+
* [Node.js 12](doc/changelogs/CHANGELOG_V12.md) **Long Term Support**
6+
* [Node.js 11](doc/changelogs/CHANGELOG_V11.md) End-of-Life
7+
* [Node.js 10](doc/changelogs/CHANGELOG_V10.md) Long Term Support
8+
* [Node.js 9](doc/changelogs/CHANGELOG_V9.md) End-of-Life
9+
* [Node.js 8](doc/changelogs/CHANGELOG_V8.md) End-of-Life
10+
* [Node.js 7](doc/changelogs/CHANGELOG_V7.md) End-of-Life
11+
* [Node.js 6](doc/changelogs/CHANGELOG_V6.md) End-of-Life
12+
* [Node.js 5](doc/changelogs/CHANGELOG_V5.md) End-of-Life
13+
* [Node.js 4](doc/changelogs/CHANGELOG_V4.md) End-of-Life
14+
* [io.js](doc/changelogs/CHANGELOG_IOJS.md) End-of-Life
15+
* [Node.js 0.12](doc/changelogs/CHANGELOG_V012.md) End-of-Life
16+
* [Node.js 0.10](doc/changelogs/CHANGELOG_V010.md) End-of-Life
1717
* [Archive](doc/changelogs/CHANGELOG_ARCHIVE.md)
1818

1919
Please use the following table to find the changelog for a specific Node.js

‎doc/api/addons.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,7 @@ NODE_MODULE_INIT(/* exports, module, context */) {
239239
Once the source code has been written, it must be compiled into the binary
240240
`addon.node` file. To do so, create a file called `binding.gyp` in the
241241
top-level of the project describing the build configuration of the module
242-
using a JSON-like format. This file is used by [node-gyp][] a tool written
242+
using a JSON-like format. This file is used by [node-gyp][], a tool written
243243
specifically to compile Node.js Addons.
244244

245245
```json

‎doc/api/errors.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -564,14 +564,14 @@ program. For a comprehensive list, see the [`errno`(3) man page][].
564564
`ulimit -n 2048` in the same shell that will run the Node.js process.
565565

566566
- `ENOENT` (No such file or directory): Commonly raised by [`fs`][] operations
567-
to indicate that a component of the specified pathname does not exist — no
567+
to indicate that a component of the specified pathname does not exist. No
568568
entity (file or directory) could be found by the given path.
569569

570570
- `ENOTDIR` (Not a directory): A component of the given pathname existed, but
571571
was not a directory as expected. Commonly raised by [`fs.readdir`][].
572572

573573
- `ENOTEMPTY` (Directory not empty): A directory with entries was the target
574-
of an operation that requires an empty directory usually [`fs.unlink`][].
574+
of an operation that requires an empty directory, usually [`fs.unlink`][].
575575

576576
- `EPERM` (Operation not permitted): An attempt was made to perform an
577577
operation that requires elevated privileges.
@@ -583,7 +583,7 @@ program. For a comprehensive list, see the [`errno`(3) man page][].
583583

584584
- `ETIMEDOUT` (Operation timed out): A connect or send request failed because
585585
the connected party did not properly respond after a period of time. Usually
586-
encountered by [`http`][] or [`net`][] — often a sign that a `socket.end()`
586+
encountered by [`http`][] or [`net`][]. Often a sign that a `socket.end()`
587587
was not properly called.
588588

589589
<a id="nodejs-error-codes"></a>

‎doc/api/http.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ To use the HTTP server and client one must `require('http')`.
99
The HTTP interfaces in Node.js are designed to support many features
1010
of the protocol which have been traditionally difficult to use.
1111
In particular, large, possibly chunk-encoded, messages. The interface is
12-
careful to never buffer entire requests or responses the
12+
careful to never buffer entire requests or responses, so the
1313
user is able to stream data.
1414

1515
HTTP message headers are represented by an object like this:
@@ -748,7 +748,7 @@ added: v0.1.29
748748

749749
Sends a chunk of the body. By calling this method
750750
many times, a request body can be sent to a
751-
server — in that case it is suggested to use the
751+
server. In that case, it is suggested to use the
752752
`['Transfer-Encoding', 'chunked']` header line when
753753
creating the request.
754754

@@ -1045,7 +1045,7 @@ affects new connections to the server, not any existing connections.
10451045
added: v0.1.17
10461046
-->
10471047

1048-
This object is created internally by an HTTP server not by the user. It is
1048+
This object is created internally by an HTTP server, not by the user. It is
10491049
passed as the second parameter to the [`'request'`][] event.
10501050

10511051
The response inherits from [Stream][], and additionally implements the

‎doc/api/http2.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2916,7 +2916,7 @@ Url {
29162916
added: v8.4.0
29172917
-->
29182918

2919-
This object is created internally by an HTTP server not by the user. It is
2919+
This object is created internally by an HTTP server, not by the user. It is
29202920
passed as the second parameter to the [`'request'`][] event.
29212921

29222922
The response inherits from [Stream][], and additionally implements the

‎doc/api/modules.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -885,7 +885,7 @@ added: v0.3.7
885885
* {Object}
886886

887887
Provides general utility methods when interacting with instances of
888-
`Module` the `module` variable often seen in file modules. Accessed
888+
`Module`, the `module` variable often seen in file modules. Accessed
889889
via `require('module')`.
890890

891891
### module.builtinModules

‎doc/api/net.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -867,7 +867,7 @@ added: v0.1.90
867867
* Returns: {boolean}
868868

869869
Sends data on the socket. The second parameter specifies the encoding in the
870-
case of a string — it defaults to UTF8 encoding.
870+
case of a string. It defaults to UTF8 encoding.
871871

872872
Returns `true` if the entire data was flushed successfully to the kernel
873873
buffer. Returns `false` if all or part of the data was queued in user memory.

‎doc/api/path.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -386,7 +386,7 @@ path.parse('/home/user/dir/file.txt');
386386
│ root │ │ name │ ext │
387387
" / home/user/dir / file .txt "
388388
└──────┴──────────────┴──────┴─────┘
389-
(all spaces in the "" line should be ignored — they are purely for formatting)
389+
(All spaces in the "" line should be ignored. They are purely for formatting.)
390390
```
391391

392392
On Windows:
@@ -408,7 +408,7 @@ path.parse('C:\\path\\dir\\file.txt');
408408
│ root │ │ name │ ext │
409409
" C:\ path\dir \ file .txt "
410410
└──────┴──────────────┴──────┴─────┘
411-
(all spaces in the "" line should be ignored — they are purely for formatting)
411+
(All spaces in the "" line should be ignored. They are purely for formatting.)
412412
```
413413

414414
A [`TypeError`][] is thrown if `path` is not a string.

‎doc/api/process.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ rejection handler.
167167

168168
There is no notion of a top level for a `Promise` chain at which rejections can
169169
always be handled. Being inherently asynchronous in nature, a `Promise`
170-
rejection can be handled at a future point in time possibly much later than
170+
rejection can be handled at a future point in time, possibly much later than
171171
the event loop turn it takes for the `'unhandledRejection'` event to be emitted.
172172

173173
Another way of stating this is that, unlike in synchronous code where there is

‎doc/api/url.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ WHATWG URL's `origin` property includes `protocol` and `host`, but not
5151
├─────────────┴─────────────────────┴────────────────────────┴──────────┴────────────────┴───────┤
5252
│ href │
5353
└────────────────────────────────────────────────────────────────────────────────────────────────┘
54-
(all spaces in the "" line should be ignored — they are purely for formatting)
54+
(All spaces in the "" line should be ignored. They are purely for formatting.)
5555
```
5656

5757
Parsing the URL string using the WHATWG API:

‎doc/guides/backporting-to-release-lines.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ hint: and commit the result with 'git commit'
7575
9. Open a pull request:
7676
1. Be sure to target the `v8.x-staging` branch in the pull request.
7777
1. Include the backport target in the pull request title in the following
78-
format `[v8.x backport] <commit title>`.
78+
format: `[v8.x backport] <commit title>`.
7979
Example: `[v8.x backport] process: improve performance of nextTick`
8080
1. Check the checkbox labeled "Allow edits from maintainers".
8181
1. In the description add a reference to the original PR.

‎doc/guides/contributing/issues.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -89,8 +89,8 @@ around it. Some contributors may have differing opinions about the issue,
8989
including whether the behavior being seen is a bug or a feature. This discussion
9090
is part of the process and should be kept focused, helpful, and professional.
9191

92-
Short, clipped responsesthat provide neither additional context nor supporting
93-
detailare not helpful or professional. To many, such responses are simply
92+
Short, clipped responses that provide neither additional context nor supporting
93+
detail are not helpful or professional. To many, such responses are simply
9494
annoying and unfriendly.
9595

9696
Contributors are encouraged to help one another make forward progress as much

0 commit comments

Comments
 (0)
Please sign in to comment.