diff options
| author | Alexey Orlenko <eaglexrlnk@gmail.com> | 2017-05-20 16:15:58 -0400 |
|---|---|---|
| committer | Refael Ackermann <refack@gmail.com> | 2017-05-25 18:49:41 -0400 |
| commit | 2af49b6c89dd4355ec0c1779fdb1fb12cf10e68d (patch) | |
| tree | d0ba4f62fff9db7d42b3f86c7358d9219b288698 /doc/STYLE_GUIDE.md | |
| parent | b3d1e3d4c720729c8f14e413a285660547ee677a (diff) | |
| download | android-node-v8-2af49b6c89dd4355ec0c1779fdb1fb12cf10e68d.tar.gz android-node-v8-2af49b6c89dd4355ec0c1779fdb1fb12cf10e68d.tar.bz2 android-node-v8-2af49b6c89dd4355ec0c1779fdb1fb12cf10e68d.zip | |
doc: make the style of notes consistent
Make the style of "Note:" paragraphs consistent and document the
guidelines in `doc/STYLE_GUIDE.md`.
PR-URL: https://github.com/nodejs/node/pull/13133
Fixes: https://github.com/nodejs/node/issues/13131
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Diffstat (limited to 'doc/STYLE_GUIDE.md')
| -rw-r--r-- | doc/STYLE_GUIDE.md | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/STYLE_GUIDE.md b/doc/STYLE_GUIDE.md index b535d2babc..efc997f185 100644 --- a/doc/STYLE_GUIDE.md +++ b/doc/STYLE_GUIDE.md @@ -61,6 +61,10 @@ * 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. [plugin]: http://editorconfig.org/#download [Oxford comma]: https://en.wikipedia.org/wiki/Serial_comma |