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/net.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/net.md')
| -rw-r--r-- | doc/api/net.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/api/net.md b/doc/api/net.md index 84bda5e4e9b..ea0b9139fd3 100644 --- a/doc/api/net.md +++ b/doc/api/net.md @@ -939,7 +939,7 @@ added: v0.1.90 * Returns: {boolean} Sends data on the socket. The second parameter specifies the encoding in the -case of a string — it defaults to UTF8 encoding. +case of a string. It defaults to UTF8 encoding. Returns `true` if the entire data was flushed successfully to the kernel buffer. Returns `false` if all or part of the data was queued in user memory. |