diff options
| author | Vse Mozhet Byt <vsemozhetbyt@gmail.com> | 2018-04-02 04:44:32 +0300 |
|---|---|---|
| committer | Vse Mozhet Byt <vsemozhetbyt@gmail.com> | 2018-04-04 12:30:36 +0300 |
| commit | 237cbe10fb82ba6ec69b14193a4a970e184306e7 (patch) | |
| tree | 8fbbac215e1f9afcac524404e766c4157d8da145 /doc/STYLE_GUIDE.md | |
| parent | f7049a20068dc8a7e904b7cdd3d5b307b595dd3a (diff) | |
| download | android-node-v8-237cbe10fb82ba6ec69b14193a4a970e184306e7.tar.gz android-node-v8-237cbe10fb82ba6ec69b14193a4a970e184306e7.tar.bz2 android-node-v8-237cbe10fb82ba6ec69b14193a4a970e184306e7.zip | |
doc,tools: formalize, unify, codify default values
PR-URL: https://github.com/nodejs/node/pull/19737
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Diffstat (limited to 'doc/STYLE_GUIDE.md')
| -rw-r--r-- | doc/STYLE_GUIDE.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/STYLE_GUIDE.md b/doc/STYLE_GUIDE.md index 009b0ee2b5..7b9ee659a1 100644 --- a/doc/STYLE_GUIDE.md +++ b/doc/STYLE_GUIDE.md @@ -59,9 +59,9 @@ * 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> - * The `type` should refer to a Node.js type or a [JavaScript type][] + * <code>* \`name\` {type|type2} Optional description. \*\*Default:\*\* \`defaultValue\`.</code> + * E.g. <code>* `byteOffset` {integer} Index of first byte to expose. **Default:** `0`.</code> + * 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> |