gh-93607: document root attribute of iterparse
#1
Conversation
This file contains hidden or 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
|
Feel free to change wording or fix grammar. |
slateny
reviewed
Jun 9, 2022
| @@ -627,6 +627,9 @@ Functions | |||
| blocking reads on *source* (or the file it names). As such, it's unsuitable | |||
| for applications where blocking reads can't be made. For fully non-blocking | |||
| parsing, see :class:`XMLPullParser`. | |||
|
|
|||
| Once *source* is fully read, the returned :term:`iterator` object is populated with `root` | |||
| attribute which references to the root element of the resulting XML tree. | |||
There was a problem hiding this comment.
I think a root attribute reads a bit better, and for formatting iirc sphinx needs to be surrounded by two grave symbols instead of just one
|
I've just noticed that I created this PR incorrectly. So I created a new branch and then PR in python/cpython. |
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.
Issue python#93607