Message154046
Converting sounds good to me, but it should be done carefully.
I think you can have two paragraphs in the docstrings: the first with the description of what it does and what it returns, and the second with the arguments.
For example Lib/xml/etree/ElementTree.py:355:
# Finds the first matching subelement, by tag name or path.
#
# @param path What element to look for.
# @keyparam namespaces Optional namespace prefix map.
# @return The first matching element, or None if no element was found.
# @defreturn Element or None
can become something like:
"""
Finds the first matching subelement, by tag name or path
and returns the first matching element, or None if no
element was found.
*path* is the element to look for and *namespace* is an
optional namespace prefix map.
""" |
|
Date |
User |
Action |
Args |
2012-02-23 03:36:34 | ezio.melotti | set | recipients:
+ ezio.melotti, scoder, eric.araujo, Arfrever, eli.bendersky, leonov, flox, docs@python |
2012-02-23 03:36:33 | ezio.melotti | set | messageid: <1329968193.97.0.794544535456.issue14006@psf.upfronthosting.co.za> |
2012-02-23 03:36:33 | ezio.melotti | link | issue14006 messages |
2012-02-23 03:36:33 | ezio.melotti | create | |
|