Message 154412 - Python tracker

Message154412

Author	flox
Recipients	Arfrever, docs@python, effbot, eli.bendersky, eric.araujo, ezio.melotti, flox, leonov, scoder
Date	2012-02-26.22:39:43
SpamBayes Score	4.46584e-05
Marked as misclassified	No
Message-id	<1330295984.63.0.409971307544.issue14006@psf.upfronthosting.co.za>
In-reply-to

Content
FWIW, Fredrik, who is the creator of ElementTree, had a preference for JavaDoc conventions, as explained here: http://bugs.python.org/issue6488#msg102087 They are compatible with the tool PythonDoc, authored by Fredrik too: http://www.effbot.org/zone/pythondoc.htm However, I agree it makes sense to turn them into docstrings if the package is only maintained in the standard library. BTW, the issue 6488 is still opened. I did not check if there's something left to do before to close it. There's also a patch attached to issue 2864, which need some review.

Content

FWIW, Fredrik, who is the creator of ElementTree, had a preference for JavaDoc conventions, as explained here: http://bugs.python.org/issue6488#msg102087

They are compatible with the tool PythonDoc, authored by Fredrik too:
http://www.effbot.org/zone/pythondoc.htm


However, I agree it makes sense to turn them into docstrings if the package is only maintained in the standard library.


BTW, the issue 6488 is still opened. I did not check if there's something left to do before to close it.
There's also a patch attached to issue 2864, which need some review.

History
Date	User	Action	Args
2012-02-26 22:39:44	flox	set	recipients: + flox, effbot, scoder, ezio.melotti, eric.araujo, Arfrever, eli.bendersky, leonov, docs@python
2012-02-26 22:39:44	flox	set	messageid: <1330295984.63.0.409971307544.issue14006@psf.upfronthosting.co.za>
2012-02-26 22:39:44	flox	link	issue14006 messages
2012-02-26 22:39:43	flox	create