Skip to content

Documentation: XML Element - pi objects instead of comment objects - #108848

Merged
serhiy-storchaka merged 4 commits into
python:mainfrom
christopheNan:xml_typo
Feb 1, 2024
Merged

Documentation: XML Element - pi objects instead of comment objects#108848
serhiy-storchaka merged 4 commits into
python:mainfrom
christopheNan:xml_typo

Conversation

@christopheNan

@christopheNan christopheNan commented Sep 3, 2023

Copy link
Copy Markdown
Contributor

While translating the XML documentation in French, I noticed that this would better describe the mechanism of parsing.


📚 Documentation preview 📚: https://cpython-previews--108848.org.readthedocs.build/

@bedevere-bot bedevere-bot added awaiting review docs Documentation in the Doc dir skip news labels Sep 3, 2023
@christopheNan

Copy link
Copy Markdown
Contributor Author

update regarding second commit : docstring and source code say it's a process instruction

Comment thread Doc/library/xml.etree.elementtree.rst Outdated
Comment thread Doc/library/xml.etree.elementtree.rst Outdated

Note that :class:`XMLParser` skips over processing instructions
in the input instead of creating comment objects for them. An
in the input instead of creating pi objects for them. An

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Is it clear? Maybe use "processing instruction objects"?

@serhiy-storchaka serhiy-storchaka left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM.

@miss-islington-app

Copy link
Copy Markdown

Thanks @christopheNan for the PR, and @serhiy-storchaka for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Feb 1, 2024
PI objects instead of comment objects.
(cherry picked from commit de6f97c)

Co-authored-by: Christophe Nanteuil <35002064+christopheNan@users.noreply.github.com>
@bedevere-app

bedevere-app Bot commented Feb 1, 2024

Copy link
Copy Markdown

GH-114854 is a backport of this pull request to the 3.12 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.12 only security fixes label Feb 1, 2024
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Feb 1, 2024
PI objects instead of comment objects.
(cherry picked from commit de6f97c)

Co-authored-by: Christophe Nanteuil <35002064+christopheNan@users.noreply.github.com>
@bedevere-app

bedevere-app Bot commented Feb 1, 2024

Copy link
Copy Markdown

GH-114855 is a backport of this pull request to the 3.11 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.11 only security fixes label Feb 1, 2024
serhiy-storchaka pushed a commit that referenced this pull request Feb 1, 2024
PI objects instead of comment objects.
(cherry picked from commit de6f97c)

Co-authored-by: Christophe Nanteuil <35002064+christopheNan@users.noreply.github.com>
serhiy-storchaka pushed a commit that referenced this pull request Feb 1, 2024
PI objects instead of comment objects.
(cherry picked from commit de6f97c)

Co-authored-by: Christophe Nanteuil <35002064+christopheNan@users.noreply.github.com>
aisk pushed a commit to aisk/cpython that referenced this pull request Feb 11, 2024
PI objects instead of comment objects.
JulienPalard pushed a commit to python/python-docs-fr that referenced this pull request Mar 23, 2024
Pour information, la traduction m'a amené à créer cette [PR](python/cpython#108848) dans CPython.

Reviewed-on: https://git.afpy.org/AFPy/python-docs-fr/pulls/187
Reviewed-by: Julien Palard <julien@palard.fr>
Co-authored-by: Christophe Nanteuil <christophe.nanteuil@gmail.com>
Co-committed-by: Christophe Nanteuil <christophe.nanteuil@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation in the Doc dir skip issue skip news

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants