rnhmjoj/magnetico
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 1 Wiki Activity

fixed formatting in CONTRIBTUING.rst

Browse Source
This commit is contained in:
Bora M. Alper 2017-06-11 10:05:35 +03:00 committed by GitHub
parent a083bf40f9
commit 200b1b65fd
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
CONTRIBUTING.rst
View File

@ -55,7 +55,8 @@ Python Coding Guidelines
* Maximum line length is 120 characters. * Maximum line length is 120 characters.
* Do not abbreviate variable names, unless the abbreviation is famous (even though it might be *obvious* in its code * Do not abbreviate variable names, unless the abbreviation is famous (even though it might be *obvious* in its code
context). For instance, `HTTP` is accepted but `_f` for *futures* and `p_` for *parent* are NOT. context). For instance, `HTTP` is accepted, but `_f` for *futures* and `p_` for *parent* are NOT.
* A possible exception of this rule is to use shorter names in case of complex symbolic manipulation and/or * A possible exception of this rule is to use shorter names in case of complex symbolic manipulation and/or
operations, for instance in complex for-loops, functions etc. Shorter names would allow the programmer to follow the operations, for instance in complex for-loops, functions etc. Shorter names would allow the programmer to follow the
flow of the operations and logic behind the manipulation more easily and hence justified. But, comments are required flow of the operations and logic behind the manipulation more easily and hence justified. But, comments are required