Message154046
| Author |
ezio.melotti |
| Recipients |
Arfrever, docs@python, eli.bendersky, eric.araujo, ezio.melotti, flox, leonov, scoder |
| Date |
2012年02月23日.03:36:33 |
| SpamBayes Score |
4.7515387e-05 |
| Marked as misclassified |
No |
| Message-id |
<1329968193.97.0.794544535456.issue14006@psf.upfronthosting.co.za> |
| In-reply-to |
| Content |
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.
""" |
|