Please sign in to comment.
Add a coding style document.
The document is largely inspired by the one in Scott Chacon's "HACKING" file  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 <firstname.lastname@example.org>
- Loading branch information...
|@@ -0,0 +1,24 @@|
|+Python code follows PEP8  with regard to coding style and PEP257  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:|
|+ """Delete a file at path 'f' if it currently exists.|
|+ Unlike os.unlink(), does not throw an exception if the file didn't already|
|+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 .|