[Doc-SIG] Python docs in reST

Skip Montanaro skip at pobox.com
Thu May 19 15:47:48 CEST 2005


>>>>> "Ian" == Ian Bicking <ianb at colorstudy.com> writes:

    Ian> Skip Montanaro wrote:
    >> >> 1. reference docs: ...
    >> >> 
    >> >> 2. user documentation: ...
    >> 
    Ian> I think that's a good distinction.  And like several people I'm not
    Ian> very interested in 1.
    >> 
    >> Ah, but I started this thread thinking about #1.  <wink>

    Ian> Well, not the #1 that Martin described (epydoc-like).  The Python
    Ian> documentation is a perfect example of #2 -- documentation written
    Ian> completely by hand that provides a structured and concise
    Ian> description of a module.  

Yes, mea culpa.  I had them flipped.  Dunno why.

Skip


More information about the Doc-SIG mailing list