[Doc-SIG] epydoc reST markup for stdlib docstrings
Nick Coghlan
ncoghlan at gmail.com
Wed Apr 14 15:58:43 CEST 2010
Barry Warsaw wrote:
> On Apr 14, 2010, at 01:30 AM, Michael Foord wrote:
>
>> Definite +1 from me on adopting reST in docstrings as a standard. I
>> haven't looked at the Epydoc convention for parameters (etc) well enough
>> to have an opinion on that.
>
> The thing I like about them is that the rules are very simple, and once
> learned are easy to remember.
Did you look at the NumPy guidelines Ralf posted?:
http://projects.scipy.org/numpy/wiki/CodingStyleGuidelines
Those look very clean to me, and fairly similar to what we already do in
the ReST docs.
Because epydoc works with tags rather than sections, it looks a lot
"noisier" to me when reading the plain text version.
Cheers,
Nick.
--
Nick Coghlan | ncoghlan at gmail.com | Brisbane, Australia
---------------------------------------------------------------
More information about the Doc-SIG
mailing list