File: CODINGSTYLE

package info (click to toggle)
bup 0.29-3
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 2,028 kB
  • sloc: sh: 8,287; python: 7,077; ansic: 1,415; pascal: 664; makefile: 239; perl: 219
file content (24 lines) | stat: -rw-r--r-- 888 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
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