1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: wrap style guide at 80 characters

Browse Source 
PR-URL: https://github.com/nodejs/node/pull/21361
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Jon Moss <me@jonathanmoss.me>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
This commit is contained in:
Rich Trott 2018-06-15 15:49:23 -07:00
parent dc10ddf034
commit dabcd4799d
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/STYLE_GUIDE.md
View File

@ -58,15 +58,19 @@
* Use a capital letter after the "Note:" label. * Use a capital letter after the "Note:" label.
* Preferably, make the note a new paragraph for better visual distinction. * Preferably, make the note a new paragraph for better visual distinction.
* Function arguments or object properties should use the following format: * Function arguments or object properties should use the following format:
* <code>* \`name\` {type|type2} Optional description. \*\*Default:\*\* \`defaultValue\`.</code> * ``` * `name` {type|type2} Optional description. **Default:** `value`. ```
* E.g. <code>* `byteOffset` {integer} Index of first byte to expose. **Default:** `0`.</code> <!--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][]. * The `type` should refer to a Node.js type or a [JavaScript type][].
* Function returns should use the following format: * Function returns should use the following format:
* <code>* Returns: {type|type2} Optional description.</code> * <code>* Returns: {type|type2} Optional description.</code>
* E.g. <code>* Returns: {AsyncHook} A reference to `asyncHook`.</code> * E.g. <code>* Returns: {AsyncHook} A reference to `asyncHook`.</code>
* Use official styling for capitalization in products and projects. * Use official styling for capitalization in products and projects.
* OK: JavaScript, Google's V8 * OK: JavaScript, Google's V8
<!--lint disable prohibited-strings remark-lint-->
* NOT OK: Javascript, Google's v8 * NOT OK: Javascript, Google's v8
<!-- lint enable prohibited-strings remark-lint-->
See also API documentation structure overview in [doctools README][]. See also API documentation structure overview in [doctools README][].