Skip to content

tools: lint doc/*.md files #21361

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Trott wants to merge 6 commits into from
Closed

tools: lint doc/*.md files #21361

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2e6a60e
doc: wrap releases.md at 80 chars
Trott Jun 15, 2018
d65c3cd
doc: correct styling of _GitHub_ in onboarding doc
Trott Jun 15, 2018
7f586a3
doc: remove linking of url text to url
Trott Jun 15, 2018
2b1e711
doc: wrap pull-requests.md at 80 characters
Trott Jun 15, 2018
302c2e0
doc: wrap style guide at 80 characters
Trott Jun 15, 2018
e79f037
tools: lint doc/*.md files
Trott Jun 15, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
doc: wrap style guide at 80 characters
  • Loading branch information
@Trott
Trott committed Jun 15, 2018
commit 302c2e0a066d99ae6f63d21d364e46d9f4733b37
8 changes: 6 additions & 2 deletions doc/STYLE_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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][].

Expand Down