diff options
| author | Rich Trott <rtrott@gmail.com> | 2019-12-13 18:18:33 +0300 |
|---|---|---|
| committer | Rich Trott <rtrott@gmail.com> | 2019-12-16 00:16:56 +0300 |
| commit | 3743fe1955067ebfd37ffc01de0c0140169bfea7 (patch) | |
| tree | 883dc4130683bbcf5749d8075e73be39d4871b01 /doc | |
| parent | ba29e270f3e8c86e45e7e323949d23955fccae1d (diff) | |
doc: add "Be direct." to the style guide
I've been doing a lot of work on-and-off to reduce unnecessary wordiness
in our docs. Codify it in the style guide.
PR-URL: https://github.com/nodejs/node/pull/30935
Reviewed-By: David Carlier <devnexen@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/STYLE_GUIDE.md | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/doc/STYLE_GUIDE.md b/doc/STYLE_GUIDE.md index 9784787428d..f0221991b79 100644 --- a/doc/STYLE_GUIDE.md +++ b/doc/STYLE_GUIDE.md @@ -55,10 +55,15 @@ * OK: JavaScript, Google's V8 <!--lint disable prohibited-strings remark-lint--> * NOT OK: Javascript, Google's v8 - * Use _Node.js_ and not _Node_, _NodeJS_, or similar variants. <!-- lint enable prohibited-strings remark-lint--> * When referring to the executable, _`node`_ is acceptable. +* Be direct. + * OK: The return value is a string. + <!-- lint disable prohibited-strings remark-lint--> + * NOT OK: It is important to note that, in all cases, the return value will be + a string regardless. + <!-- lint enable prohibited-strings remark-lint--> See also API documentation structure overview in [doctools README][]. |