doc: wrap style guide at 80 characters

PR-URL: #21361 Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Refael Ackermann <[email protected]> Reviewed-By: Jon Moss <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
nodejs · Jun 16, 2018 · 4566eba · 4566eba
1 parent 6c41f33
commit 4566eba
Showing 1 changed file with 6 additions and 2 deletions.
diff --git a/doc/STYLE_GUIDE.md b/doc/STYLE_GUIDE.md
@@ -58,15 +58,19 @@
   * Use a capital letter after the "Note:" label.
   * Preferably, make the note a new paragraph for better visual distinction.
 * Function arguments or object properties should use the following format:
-  * <code>* \`name\` {type|type2} Optional description. \*\*Default:\*\* \`defaultValue\`.</code>
-  * E.g. <code>* `byteOffset` {integer} Index of first byte to expose. **Default:** `0`.</code>
+  * ``` * `name` {type|type2} Optional description. **Default:** `value`. ```
+  <!--lint disable maximum-line-length remark-lint-->
+  * For example: <code>* `byteOffset` {integer} Index of first byte to expose. **Default:** `0`.</code>
+  <!--lint enable maximum-line-length remark-lint-->
   * The `type` should refer to a Node.js type or a [JavaScript type][].
 * Function returns should use the following format:
   * <code>* Returns: {type|type2} Optional description.</code>
   * E.g. <code>* Returns: {AsyncHook} A reference to `asyncHook`.</code>
 * Use official styling for capitalization in products and projects.
   * OK: JavaScript, Google's V8
+  <!--lint disable prohibited-strings remark-lint-->
   * NOT OK: Javascript, Google's v8
+  <!-- lint enable prohibited-strings remark-lint-->
 
 See also API documentation structure overview in [doctools README][].