gh-126273: added clinic docstrings to elementtree #126274
Open
+335
−51
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
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]>
Comment on lines
+1259
to
+1260
| *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.
Suggested change
| Returns list containing all matching elements in document order. | |
| Return a list containing all matching elements in document order. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
xml.etreeC implementation. #126273