From 237cbe10fb82ba6ec69b14193a4a970e184306e7 Mon Sep 17 00:00:00 2001 From: Vse Mozhet Byt Date: Mon, 2 Apr 2018 04:44:32 +0300 Subject: doc,tools: formalize, unify, codify default values PR-URL: https://github.com/nodejs/node/pull/19737 Reviewed-By: Gus Caplan Reviewed-By: James M Snell Reviewed-By: Trivikram Kamat --- doc/STYLE_GUIDE.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'doc/STYLE_GUIDE.md') 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: - * * \`name\` {type|type2} Optional description. \*\*Default:\*\* \`defaultValue\` - * E.g. * `byteOffset` {integer} Index of first byte to expose. **Default:** `0` - * The `type` should refer to a Node.js type or a [JavaScript type][] + * * \`name\` {type|type2} Optional description. \*\*Default:\*\* \`defaultValue\`. + * E.g. * `byteOffset` {integer} Index of first byte to expose. **Default:** `0`. + * The `type` should refer to a Node.js type or a [JavaScript type][]. * Function returns should use the following format: * * Returns: {type|type2} Optional description. * E.g. * Returns: {AsyncHook} A reference to `asyncHook`. -- cgit v1.2.3