File tree 1 file changed +6
-2
lines changed
1 file changed +6
-2
lines changed Original file line number Diff line number Diff line change 58
58
* Use a capital letter after the "Note:" label.
59
59
* Preferably, make the note a new paragraph for better visual distinction.
60
60
* 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-->
63
65
* The ` type ` should refer to a Node.js type or a [ JavaScript type] [ ] .
64
66
* Function returns should use the following format:
65
67
* <code >* Returns: {type|type2} Optional description.</code >
66
68
* E.g. <code >* Returns: {AsyncHook} A reference to ` asyncHook ` .</code >
67
69
* Use official styling for capitalization in products and projects.
68
70
* OK: JavaScript, Google's V8
71
+ <!-- lint disable prohibited-strings remark-lint-->
69
72
* NOT OK: Javascript, Google's v8
73
+ <!-- lint enable prohibited-strings remark-lint-->
70
74
71
75
See also API documentation structure overview in [ doctools README] [ ] .
72
76
You can’t perform that action at this time.
0 commit comments