good style guides for python-style documentation ?
Ron Adam
rrr at ronadam.com
Thu Apr 6 15:50:09 EDT 2006
> (reposted from doc-sig, which seems to be mostly dead
> these days).
>
> over at the pytut wiki, "carndt" asked:
>
> Are there any guidelines about conventions concerning
> punctuation, text styles and language style (e.g. how
> to address the reader)?
>
> any suggestions from this list ?
>
> </F>
Well there's:
PEP 8 -- Style Guide for Python Code
http://www.python.org/dev/peps/pep-0008/
But I presume you already know that one. It covers doc strings some,
but not general documentation. A how-to on documenting would be nice.
Cheers,
Ron
More information about the Python-list
mailing list