Permalink
Browse files

Add a coding style document.

The document is largely inspired by the one in Scott Chacon's "HACKING"
file [1] in his 'agitmemnon-server' repository on GitHub with some
precision on the docstring style that was adopted for bup.

http://github.com/schacon/agitmemnon-server/blob/master/HACKING

Signed-off-by: Gabriel Filion <lelutin@gmail.com>
  • Loading branch information...
1 parent e70cfe1 commit ac5848c7a960377fb5cf9c76abe7cc7241af50b9 @lelutin lelutin committed with Oct 11, 2010
Showing with 24 additions and 0 deletions.
  1. +24 −0 CODINGSTYLE
View
@@ -0,0 +1,24 @@
+Python code follows PEP8 [1] with regard to coding style and PEP257 [2] with
+regard to docstring style. Multi-line docstrings should have one short summary
+line, followed by a blank line and a series of paragraphs. The last paragraph
+should be followed by a line that closes the docstring (no blank line in
+between). Here's an example from lib/bup/helpers.py:
+
+def unlink(f):
+ """Delete a file at path 'f' if it currently exists.
+
+ Unlike os.unlink(), does not throw an exception if the file didn't already
+ exist.
+ """
+ #code...
+
+Module-level docstrings follow exactly the same guidelines but without the
+blank line between the summary and the details.
+
+
+The C implementations should follow the kernel/git coding style [3].
+
+
+[1]:http://www.python.org/dev/peps/pep-0008/
+[2]:http://www.python.org/dev/peps/pep-0257/
+[3]:http://www.kernel.org/doc/Documentation/CodingStyle

0 comments on commit ac5848c

Please sign in to comment.