Skip to content

Commit b14e104

Browse files
committed
Some additional coding guidelines
1 parent f1647f2 commit b14e104

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,14 @@
1818

1919
In general, I follow strict pep8 and pyflakes. All code must pass these tests. Since we support python 2.4-3.4 and pypy, pyflakes reports unknown names in python 3. pyflakes is run in python 2.7 only in my tests.
2020

21+
## Some other points
22+
23+
1. Do not use `\` for line continuations, long strings should be wrapped in `()`. Imports should start a brand new line in the form of `from foo import...`
24+
1. String quoting should be done with single quotes `'`, except for situations where you would otherwise have to escape an internal single quote
25+
1. Docstrings should use three double quotes `"""`
26+
1. All functions, classes and modules should have docstrings following both the PEP257 and PEP8 standards
27+
1. Inline comments should only be used on code where it is not immediately obvious what the code achieves
28+
2129
# Supported Python Versions
2230

2331
All code needs to support Python 2.4-3.4 and pypy.

0 commit comments

Comments
 (0)