diff options
Diffstat (limited to 'doc/STYLE_GUIDE.md')
-rw-r--r-- | doc/STYLE_GUIDE.md | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/doc/STYLE_GUIDE.md b/doc/STYLE_GUIDE.md index 610b012dda..5d0f4f14eb 100644 --- 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][]. |