Re: epydoc reST markup for stdlib docstrings

Georg Brandl <[email protected]>
Newsgroups gmane.comp.python.documentation
Message-ID <[email protected]>
Am 14.04.2010 13:08, schrieb Fred Drake:
> On Wed, Apr 14, 2010 at 8:44 AM, Michael Foord
> <[email protected]> wrote:
>> I too would prefer a consistent pattern be adopted for the Python standard
>> library. Good luck finding someone to go and change all the docstrings in
>> the standard library to use it...
> 
> We found someone interested in converting the LaTeX to ReST, didn't we?  :-)

That was a more interesting task :)  However, I'm not opposed to doing
stupid, repetitive things every now and then, and I hope I can find a
few others to share the task.

> If we can come up with a good recommendation, it'll take hold fairly
> thoroughly.  Not quickly at first, but once there's value (tools) to
> be had it'll happen.
> 
> The value for the standard library is that the documentation
> maintenance can be moved closer to the code, and is less likely to get
> out of sync.

Exactly.

Georg

_______________________________________________
Doc-SIG maillist  -  [email protected]
http://mail.python.org/mailman/listinfo/doc-sig
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.