[issue6488] ElementTree documentation refers to "path" with no explanation, and inconsistently

[Fredrik Lundh]

Fredrik Lundh <fredrik at effbot.org> added the comment:

> As per PEP 257, “Returns” should become “Return” (it’s a command, not a description).

Upstream ET uses JavaDoc conventions, where the conventions are
designed by technical writers, not hackers.  In JavaDoc, descriptions
are 3rd person declarative (after all, the documentation describes
what the function does, not what you want it to do).

http://java.sun.com/j2se/javadoc/writingdoccomments/

The incompatibilities with Python's NIH-standards are unfortunate, but
that's the way it is.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue6488>
_______________________________________