diff options
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 |