Skip to content
This repository was archived by the owner on Mar 25, 2018. It is now read-only.

Commit eaba2f3

Browse files
committed
update style guide
1 parent 416ac05 commit eaba2f3

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

STYLE-GUIDE.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,10 @@
5454
your point, not as complete running programs. If a complete running program
5555
is necessary, include it as an asset in `assets/code-examples` and link to
5656
it.
57+
* When using underscores, asterisks and backticks please use proper escaping (**\\\_**, **\\\*** and **\\\`** instead of **\_**, **\*** and **\`**)
58+
* References to constructor functions should use PascalCase
59+
* References to constructor instances should be camelCased
60+
* References to methods should be used with parenthesis: `socket.end()` instead of `socket.end`
5761

5862
[plugin]: http://editorconfig.org/#download
5963
[Oxford comma]: https://en.wikipedia.org/wiki/Serial_comma

0 commit comments

Comments
 (0)