Skip to content
This repository has been archived by the owner on Apr 22, 2023. It is now read-only.

collected new content #199

Merged
merged 3 commits into from
Jul 12, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
8 changes: 2 additions & 6 deletions content/v10.x/en-US/doc/STYLE_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,6 @@
clause — a subject, verb, and an object.
* Outside of the wrapping element if the wrapping element contains only a
fragment of a clause.
* Place end-of-sentence punctuation inside wrapping elements — periods go
inside parentheses and quotes, not after.
* Documents must start with a level-one heading.
* Prefer affixing links to inlining links — prefer `[a link][]` to
`[a link](http://example.com)`.
Expand Down Expand Up @@ -53,10 +51,6 @@
* References to constructor instances should use camelCase.
* References to methods should be used with parentheses: for example,
`socket.end()` instead of `socket.end`.
* To draw special attention to a note, adhere to the following guidelines:
* Make the "Note:" label italic, i.e. `*Note*:`.
* 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:** `value`. ```
<!--lint disable maximum-line-length remark-lint-->
Expand All @@ -71,6 +65,8 @@
<!--lint disable prohibited-strings remark-lint-->
* NOT OK: Javascript, Google's v8
<!-- lint enable prohibited-strings remark-lint-->
* Use _Node.js_ and not _Node_, _NodeJS_, or similar variants.
* When referring to the executable, _`node`_ is acceptable.

See also API documentation structure overview in [doctools README][].

Expand Down
Loading