Skip to content

Added general recommendations #4002

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

Added general recommendations #4002

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
40a427b
Added general recommendations
mesqueeb Apr 27, 2018
0fce8f2
update ` to ``
mesqueeb Apr 27, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion docs/style-guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -931,4 +931,10 @@ built-in or otherwise reserved name.
General Recommendations
=======================

TODO
* Function parameter variable names

It's convention to start function parameter variable names with an underscore (``_``) in order to differentiate them from global variables. e.g. ``function myFunction(_foo, _bar) { }``

* Private functions

It's convention to start private function names with an underscore (``_``). e.g. ``_myPrivateFunction``