Skip to content
Permalink
Browse files

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: #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>
  • Loading branch information
Trott committed Dec 13, 2019
1 parent ba29e27 commit 3743fe1955067ebfd37ffc01de0c0140169bfea7
Showing with 6 additions and 1 deletion.
  1. +6 −1 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][].

0 comments on commit 3743fe1

Please sign in to comment.
You can’t perform that action at this time.