summary refs log tree commit diff
path: root/docs/implementation-notes/code_style.rst
diff options
context:
space:
mode:
authorMatthew Hodgson <matthew@matrix.org>2014-11-11 21:03:10 +0200
committerMatthew Hodgson <matthew@matrix.org>2014-11-12 00:18:25 +0200
commit0c59bc5e359c54092cc41457a86db562bb8c6157 (patch)
tree1a17159770830ad74feb965f5c3e9a1a87626597 /docs/implementation-notes/code_style.rst
parenttypo (diff)
downloadsynapse-0c59bc5e359c54092cc41457a86db562bb8c6157.tar.xz
move stuff out of implementation-notes - /everything/ here should be implementation-notes now
Diffstat (limited to 'docs/implementation-notes/code_style.rst')
-rw-r--r--docs/implementation-notes/code_style.rst18
1 files changed, 0 insertions, 18 deletions
diff --git a/docs/implementation-notes/code_style.rst b/docs/implementation-notes/code_style.rst
deleted file mode 100644
index d7e2d5e69e..0000000000
--- a/docs/implementation-notes/code_style.rst
+++ /dev/null
@@ -1,18 +0,0 @@
-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/)