A place to note Zwiki code style guidelines.

Docstrings

2007/06: Previously, following some python PEP or other, I (SM) tried to make docstrings fit this pattern:

def func(self):
    """
    One-sentence summary, < 80 characters, preceded by a newline.

    Additional notes, after a blank line,
    terminated with a newline.
    """
    code

I am gradually switching to an easier, more compact form, currently this:

def func(self):
    """One-sentence summary, any length. Followed by any additional
    notes, any layout. If docstring is more than one line, terminate
    with a newline.
    """
    code

def func(self):
    """Short docstring."""
    code

If I need something fancy like bullet lists, I use RestructuredText markup, which Epydoc can format for the APIDocs.