Matrix-Mirrors/anonymousland-synapse
1
0
Fork 0
mirror of https://git.anonymousland.org/anonymousland/synapse.git synced 2024-12-26 21:09:23 -05:00
Code Issues Packages Projects Releases Wiki Activity

update codestyle based on debate on #matrix-dev

Browse Source
This commit is contained in:
Matthew Hodgson 2014-12-10 13:11:43 +00:00
parent 6497caee7c
commit 32bc2b4fc1
1 changed files with 34 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
docs/code_style.rst
View File

@ -1,10 +1,14 @@
Basically, PEP8 Basically, PEP8
- Max line width: 80 chars. - NEVER tabs. 4 spaces to indent.
- Max line width: 79 chars (with flexibility to overflow by a "few chars" if
the overflowing content is not semantically significant and avoids an
explosion of vertical whitespace).
- Use camel case for class and type names - Use camel case for class and type names
- Use underscores for functions and variables. - Use underscores for functions and variables.
- Use double quotes. - Use double quotes.
- Use parentheses instead of '\' for line continuation where ever possible (which is pretty much everywhere) - Use parentheses instead of '\\' for line continuation where ever possible
(which is pretty much everywhere)
- There should be max a single new line between: - There should be max a single new line between:
- statements - statements
- functions in a class - functions in a class
@ -14,5 +18,32 @@ Basically, PEP8
- a single space after a comma - a single space after a comma
- a single space before and after for '=' when used as assignment - a single space before and after for '=' when used as assignment
- no spaces before and after for '=' for default values and keyword arguments. - no spaces before and after for '=' for default values and keyword arguments.
- Indenting must follow PEP8; either hanging indent or multiline-visual indent
depending on the size and shape of the arguments and what makes more sense to
the author. In other words, both this::
Comments should follow the google code style. This is so that we can generate documentation with sphinx (http://sphinxcontrib-napoleon.readthedocs.org/en/latest/) print("I am a fish %s", "moo")
and this::
print("I am a fish %s",
"moo")
and this::
print(
"I am a fish %s",
"moo"
)
...are valid, although given each one takes up 2x more vertical space than
the previous, it's up to the author's discretion as to which layout makes most
sense for their function invocation. (e.g. if they want to add comments
per-argument, or put expressions in the arguments, or group related arguments
together, or want to deliberately extend or preserve vertical/horizontal
space)
Comments should follow the google code style. This is so that we can generate
documentation with sphinx (http://sphinxcontrib-napoleon.readthedocs.org/en/latest/)
Code should pass pep8 --max-line-length=100 without any warnings.