Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork32k
gh-126273: added clinic docstrings to elementtree#126274
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
base:main
Are you sure you want to change the base?
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 OutdatedShow resolvedHide resolved
Uh oh!
There was an error while loading.Please reload this page.
…6273.t_qOoH.rstCo-authored-by: Peter Bierma <zintensitydev@gmail.com>
| *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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Consider using per-parameter docstrings here (see theArgument 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Please consistently use the imperative mood for reference prose. Ditto for the rest of the PR.
| Returnslistcontainingallmatchingelementsindocumentorder. | |
| Returnalistcontainingallmatchingelementsindocumentorder. |
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
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 |
The following commit authors need to sign the Contributor License Agreement: |
Uh oh!
There was an error while loading.Please reload this page.
xml.etreeC implementation. #126273