djsundog/circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

CODECONVENTIONS.md: Fix typos.

Browse Source
This commit is contained in:
Scott Shawcroft 2016-08-24 13:19:25 -07:00
parent 258804ab16
commit dade18bddf
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
CODECONVENTIONS.md
View File

@ -24,7 +24,7 @@ a change in a detail, if needed. Any change beyond 5 lines would likely
require such detailed description. require such detailed description.
To get good practical examples of good commits and their messages, browse To get good practical examples of good commits and their messages, browse
thry the `git log` of the project. the `git log` of the project.
Python code conventions Python code conventions
======================= =======================
@ -33,7 +33,7 @@ Python code follows [PEP 8](http://legacy.python.org/dev/peps/pep-0008/).
Naming conventions: Naming conventions:
- Module names are short and all lowercase; eg pyb, stm. - Module names are short and all lowercase; eg pyb, stm.
- Class names are CamelCase, with abreviations all uppercase; eg I2C, not - Class names are CamelCase, with abbreviations all uppercase; eg I2C, not
I2c. I2c.
- Function and method names are all lowercase with words separated by - Function and method names are all lowercase with words separated by
a single underscore as necessary to improve readability; eg mem_read. a single underscore as necessary to improve readability; eg mem_read.
@ -52,7 +52,7 @@ White space:
keyword and the opening parenthesis. keyword and the opening parenthesis.
- Put 1 space after a comma, and 1 space around operators. - Put 1 space after a comma, and 1 space around operators.
Braces: Braces:
- Use braces for all blocks, even no-line and single-line pieces of - Use braces for all blocks, even no-line and single-line pieces of
code. code.
- Put opening braces on the end of the line it belongs to, not on - Put opening braces on the end of the line it belongs to, not on