gh-126273: added clinic docstrings to elementtree #126274
Conversation
|
clinic/* files are autogenerated by Tools/clinic/clinic.py. You should modify instead clinic input - Modules/_elementtree.c in your case, I guess. See also: https://devguide.python.org/development-tools/clinic/ |
|
Thanks, will do that now. |
Misc/NEWS.d/next/Documentation/2024-11-01-12-35-32.gh-issue-126273.t_qOoH.rst
Outdated
Show resolved
Hide resolved
…6273.t_qOoH.rst Co-authored-by: Peter Bierma <[email protected]>
| *path* is a string having either an element tag or an XPath, | ||
| *namespaces* is an optional mapping from namespace prefix to full name. |
There was a problem hiding this comment.
Consider using per-parameter docstrings here (see the Argument Clinic Howto for inspiration).
Consider this also for the rest of the PR.
| *path* is a string having either an element tag or an XPath, | ||
| *namespaces* is an optional mapping from namespace prefix to full name. | ||
|
|
||
| Returns list containing all matching elements in document order. |
There was a problem hiding this comment.
Please consistently use the imperative mood for reference prose. Ditto for the rest of the PR.
| Returns list containing all matching elements in document order. | |
| Return a list containing all matching elements in document order. |
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
There was a problem hiding this comment.
Normally we try to align the docstrings with the reference text in the documentation. In some places, this is already done (the added docstring is similar or identical to the reference docs), but in some places it differs significantly. If the reason for the deviation is that the docs are inaccurate, we should IMO fix them (first), and then align the added docstrings to the amended docs. Moreover, my previous round of review remarks have not been addressed yet.
|
A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated. Once you have made the requested changes, please leave a comment on this pull request containing the phrase |
xml.etreeC implementation. #126273