Commit fb3af1b
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 87543f0 commit fb3af1b
1 file changed
Lines changed: 6 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -55,10 +55,15 @@ | |||
| 55 | 55 | * OK: JavaScript, Google's V8 | |
| 56 | 56 | <!--lint disable prohibited-strings remark-lint--> | |
| 57 | 57 | * NOT OK: Javascript, Google's v8 | |
| 58 | - | ||
| 59 | 58 | * Use _Node.js_ and not _Node_, _NodeJS_, or similar variants. | |
| 60 | 59 | <!-- lint enable prohibited-strings remark-lint--> | |
| 61 | 60 | * 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--> | ||
| 62 | 67 | ||
| 63 | 68 | See also API documentation structure overview in [doctools README][]. | |
| 64 | 69 | ||
0 commit comments