mirror of
https://git.anonymousland.org/anonymousland/synapse.git
synced 2025-06-19 09:34:08 -04:00
Shuffle files around in /docs
This commit is contained in:
parent
d027e859cd
commit
660129deb1
6 changed files with 0 additions and 0 deletions
18
docs/implementation-notes/code_style.rst
Normal file
18
docs/implementation-notes/code_style.rst
Normal file
|
@ -0,0 +1,18 @@
|
|||
Basically, PEP8
|
||||
|
||||
- Max line width: 80 chars.
|
||||
- Use camel case for class and type names
|
||||
- Use underscores for functions and variables.
|
||||
- Use double quotes.
|
||||
- Use parentheses instead of '\' for line continuation where ever possible (which is pretty much everywhere)
|
||||
- There should be max a single new line between:
|
||||
- statements
|
||||
- functions in a class
|
||||
- There should be two new lines between:
|
||||
- definitions in a module (e.g., between different classes)
|
||||
- There should be spaces where spaces should be and not where there shouldn't be:
|
||||
- a single space after a comma
|
||||
- a single space before and after for '=' when used as assignment
|
||||
- no spaces before and after for '=' for default values and keyword arguments.
|
||||
|
||||
Comments should follow the google code style. This is so that we can generate documentation with sphinx (http://sphinxcontrib-napoleon.readthedocs.org/en/latest/)
|
Loading…
Add table
Add a link
Reference in a new issue