From fb3af1b23a4f926a4c96bacf6a24d3d07fff0df5 Mon Sep 17 00:00:00 2001
From: Rich Trott <rtrott@gmail.com>
Date: Fri, 13 Dec 2019 10:18:33 -0500
Subject: [PATCH] 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>
---
 doc/STYLE_GUIDE.md | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/doc/STYLE_GUIDE.md b/doc/STYLE_GUIDE.md
index 9784787428dbf1..f0221991b79be2 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][].