gh-139006: Doc: Clarify html.escape function description #139016
Merged
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
bedevere-app
bot
added
awaiting review
docs
StanFromIreland
changed the title
ezio-melotti
approved these changes
Sep 17, 2025
ezio-melotti
added
needs backport to 3.13
|
Thanks @PrinceNaroliya for the PR, and @ezio-melotti for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Sep 17, 2025
…nGH-139016) (cherry picked from commit 81c975b) Co-authored-by: PrinceNaroliya <naroliyaprince@gmail.com> Doc: Clarify html.escape function description (pythonGH-139006)
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Sep 17, 2025
…nGH-139016) (cherry picked from commit 81c975b) Co-authored-by: PrinceNaroliya <naroliyaprince@gmail.com> Doc: Clarify html.escape function description (pythonGH-139006)
|
GH-139036 is a backport of this pull request to the 3.14 branch. |
|
GH-139037 is a backport of this pull request to the 3.13 branch. |
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.
This PR clarifies the documentation of
html.escape.Previously, the docs said:
This wording was slightly misleading because the default value of quote is already
True.Readers might think they need to explicitly pass
quote=True, but in reality, the default behavior already translates (") and (').✅ Changes in this PR:
Trueby default.False, (") and (') are not translated.Issue: gh-139006
📚 Documentation preview 📚: https://cpython-previews--139016.org.readthedocs.build/