Skip to content

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

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.

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

Merged
merged 4 commits into from
Feb 1, 2024

Conversation

christopheNan
Copy link
Contributor

@christopheNan christopheNan commented Sep 3, 2023

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
Contributor Author

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

@@ -661,7 +661,7 @@ Functions
given. Returns an element instance, representing a processing instruction.

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
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"?

Copy link
Member

@serhiy-storchaka serhiy-storchaka left a comment

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

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
Copy link

bedevere-app bot commented Feb 1, 2024

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
Copy link

bedevere-app bot commented Feb 1, 2024

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