From dabcd4799de19a8af0fd2ac341619d4d869a972c Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Fri, 15 Jun 2018 15:49:23 -0700 Subject: doc: wrap style guide at 80 characters PR-URL: https://github.com/nodejs/node/pull/21361 Reviewed-By: Richard Lau Reviewed-By: Refael Ackermann Reviewed-By: Jon Moss Reviewed-By: Vse Mozhet Byt Reviewed-By: Luigi Pinca --- doc/STYLE_GUIDE.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) (limited to 'doc/STYLE_GUIDE.md') 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: - * * \`name\` {type|type2} Optional description. \*\*Default:\*\* \`defaultValue\`. - * E.g. * `byteOffset` {integer} Index of first byte to expose. **Default:** `0`. + * ``` * `name` {type|type2} Optional description. **Default:** `value`. ``` + + * For example: * `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`. * Use official styling for capitalization in products and projects. * OK: JavaScript, Google's V8 + * NOT OK: Javascript, Google's v8 + See also API documentation structure overview in [doctools README][]. -- cgit v1.2.3