Skip to content

gh-93607: document root attribute of iterparse#1

Closed
Prometheus3375 wants to merge 2 commits into
mainfrom
Prometheus3375-iterparse-root-docs
Closed

gh-93607: document root attribute of iterparse#1
Prometheus3375 wants to merge 2 commits into
mainfrom
Prometheus3375-iterparse-root-docs

Conversation

@Prometheus3375

Copy link
Copy Markdown
Owner

Issue python#93607

@Prometheus3375

Copy link
Copy Markdown
Owner Author

Feel free to change wording or fix grammar.

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.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed!

@Prometheus3375

Prometheus3375 commented Nov 12, 2022

Copy link
Copy Markdown
Owner Author

I've just noticed that I created this PR incorrectly. So I created a new branch and then PR in python/cpython.

python#99410

@Prometheus3375 Prometheus3375 deleted the Prometheus3375-iterparse-root-docs branch November 12, 2022 08:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants