From eaba2f338994b7cc0a15751ce9b7ce6864b1a746 Mon Sep 17 00:00:00 2001 From: Alejandro Oviedo Date: Thu, 11 Feb 2016 12:37:56 -0300 Subject: [PATCH] update style guide --- STYLE-GUIDE.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/STYLE-GUIDE.md b/STYLE-GUIDE.md index 3d9dcfe..10f2642 100644 --- a/STYLE-GUIDE.md +++ b/STYLE-GUIDE.md @@ -54,6 +54,10 @@ your point, not as complete running programs. If a complete running program is necessary, include it as an asset in `assets/code-examples` and link to it. +* When using underscores, asterisks and backticks please use proper escaping (**\\\_**, **\\\*** and **\\\`** instead of **\_**, **\*** and **\`**) +* References to constructor functions should use PascalCase +* References to constructor instances should be camelCased +* References to methods should be used with parenthesis: `socket.end()` instead of `socket.end` [plugin]: http://editorconfig.org/#download [Oxford comma]: https://en.wikipedia.org/wiki/Serial_comma