Add a coding style document.

[bup.git] / CODINGSTYLE

diff --git a/CODINGSTYLE b/CODINGSTYLE
new file mode 100644 (file)
index 0000000..e28df2f
--- /dev/null
+++ b/CODINGSTYLE
@@ -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