Skip to content

Commit 559284b

Browse files
TrottMylesBorins
authored andcommitted
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>
1 parent f30b771 commit 559284b

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

doc/STYLE_GUIDE.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -55,10 +55,15 @@
5555
* OK: JavaScript, Google's V8
5656
<!--lint disable prohibited-strings remark-lint-->
5757
* NOT OK: Javascript, Google's v8
58-
5958
* Use _Node.js_ and not _Node_, _NodeJS_, or similar variants.
6059
<!-- lint enable prohibited-strings remark-lint-->
6160
* When referring to the executable, _`node`_ is acceptable.
61+
* Be direct.
62+
* OK: The return value is a string.
63+
<!-- lint disable prohibited-strings remark-lint-->
64+
* NOT OK: It is important to note that, in all cases, the return value will be
65+
a string regardless.
66+
<!-- lint enable prohibited-strings remark-lint-->
6267

6368
See also API documentation structure overview in [doctools README][].
6469

0 commit comments

Comments
 (0)