We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent 5cb1744 commit 9e5d39cCopy full SHA for 9e5d39c
doc/STYLE_GUIDE.md
@@ -55,10 +55,15 @@
55
* OK: JavaScript, Google's V8
56
<!--lint disable prohibited-strings remark-lint-->
57
* NOT OK: Javascript, Google's v8
58
-
59
* Use _Node.js_ and not _Node_, _NodeJS_, or similar variants.
60
<!-- lint enable prohibited-strings remark-lint-->
61
* When referring to the executable, _`node`_ is acceptable.
+* 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-->
67
68
See also API documentation structure overview in [doctools README][].
69
0 commit comments