◐ Shell
clean mode source ↗

doc: wrap style guide at 80 characters · nodejs/node@4566eba

@@ -58,15 +58,19 @@

5858

* Use a capital letter after the "Note:" label.

5959

* Preferably, make the note a new paragraph for better visual distinction.

6060

* Function arguments or object properties should use the following format:

61-

* <code>* \`name\` {type|type2} Optional description. \*\*Default:\*\* \`defaultValue\`.</code>

62-

* E.g. <code>* `byteOffset` {integer} Index of first byte to expose. **Default:** `0`.</code>

61+

* ``` * `name` {type|type2} Optional description. **Default:** `value`. ```

62+

<!--lint disable maximum-line-length remark-lint-->

63+

* For example: <code>* `byteOffset` {integer} Index of first byte to expose. **Default:** `0`.</code>

64+

<!--lint enable maximum-line-length remark-lint-->

6365

* The `type` should refer to a Node.js type or a [JavaScript type][].

6466

* Function returns should use the following format:

6567

* <code>* Returns: {type|type2} Optional description.</code>

6668

* E.g. <code>* Returns: {AsyncHook} A reference to `asyncHook`.</code>

6769

* Use official styling for capitalization in products and projects.

6870

* OK: JavaScript, Google's V8

71+

<!--lint disable prohibited-strings remark-lint-->

6972

* NOT OK: Javascript, Google's v8

73+

<!-- lint enable prohibited-strings remark-lint-->

70747175

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

7276