Skip to content

Commit

Permalink
doc: add "Be direct." to the style guide
Browse files Browse the repository at this point in the history
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: #30935
Reviewed-By: David Carlier <[email protected]>
Reviewed-By: Ruben Bridgewater <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: James M Snell <[email protected]>
  • Loading branch information
Trott authored and MylesBorins committed Dec 17, 2019
1 parent f30b771 commit 559284b
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion doc/STYLE_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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][].

Expand Down

0 comments on commit 559284b

Please sign in to comment.