diff options
| author | Rich Trott <rtrott@gmail.com> | 2020-03-04 08:23:59 +0300 |
|---|---|---|
| committer | Rich Trott <rtrott@gmail.com> | 2020-03-06 09:25:42 +0300 |
| commit | b6cd2155c3442a8c56aa6f6ffa0dc9b6a308a7b1 (patch) | |
| tree | 5aa6651cd92dac327193a4c850f549aff8c24821 /doc/api/addons.md | |
| parent | 5cc0754090b4dc504652ea57803312c9b9f1cef0 (diff) | |
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: https://github.com/nodejs/node/pull/32080
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Diffstat (limited to 'doc/api/addons.md')
| -rw-r--r-- | doc/api/addons.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/api/addons.md b/doc/api/addons.md index 6b77338348e..93f99afbeee 100644 --- a/doc/api/addons.md +++ b/doc/api/addons.md @@ -313,7 +313,7 @@ require('./build/Release/addon'); Once the source code has been written, it must be compiled into the binary `addon.node` file. To do so, create a file called `binding.gyp` in the top-level of the project describing the build configuration of the module -using a JSON-like format. This file is used by [node-gyp][] — a tool written +using a JSON-like format. This file is used by [node-gyp][], a tool written specifically to compile Node.js Addons. ```json |