PyAtom, a Python module for creating Atom syndication feeds

Steve R. Hastings steve at hastings.org
Thu Feb 23 12:52:45 EST 2006


> docstrings of method are messed up (why you begin them from the column 0?)

Well, it seemed like a good idea at the time.

I wanted all my docstrings to look nice in an 80-column terminal
emulator, and it's easy to format them to similar lengths when they all
start in the same column.  My standard is to use up to 72 columns for
line lengths.

When you have a class, which contains a function, which has a docstring,
the docstring is indented at least 3 levels.  If you then use 72 columns,
the strings will wrap in the source code.

All that said, if the community doesn't do it this way, I'll go ahead and
change it.  It seemed like a good way to go but I'm not combative about it.


>     Function Names
> 
>       Function names should be lowercase, with words separated by underscores
>       as necessary to improve readability.
> 
>       mixedCase is allowed only in contexts where that's already the
>       prevailing style (e.g. threading.py), to retain backwards compatibility.

Oh, right.  I do have some mixed-case function names; I guess I'd better
rename them right away.

By the way, I started PyAtom as a learning project.  Now that it's done I
want to share it, but I didn't study PEP 8 very much before I started it.

Thank you for the feedback.
-- 
Steve R. Hastings    "Vita est"
steve at hastings.org    http://www.blarg.net/~steveha




More information about the Python-list mailing list