Skip to content

gh-93607: document root attribute of iterparse #1

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.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Prometheus3375 wants to merge 2 commits into from
Closed

gh-93607: document root attribute of iterparse #1

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8e95ae3
Document root attribute of iterparse
Prometheus3375 Jun 8, 2022
5a32200
Fix root formatting
Prometheus3375 Jun 9, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions Doc/library/xml.etree.elementtree.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 a ``root``
attribute which references to the root element of the resulting XML tree.

@slateny slateny Jun 9, 2022

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

@Prometheus3375 Prometheus3375 Jun 11, 2022

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!


.. note::

Expand Down