From 1641c3dfecb223278cded2f54f8552a90253bb97 Mon Sep 17 00:00:00 2001 From: PrinceNaroliya Date: Wed, 17 Sep 2025 19:15:34 +0530 Subject: [PATCH] gh-139006: Doc: Clarify html.escape function description (GH-139016) (cherry picked from commit 81c975bcfc1ac0533f9489a37e501ad5d3bdb4eb) Co-authored-by: PrinceNaroliya Doc: Clarify html.escape function description (GH-139006) --- Doc/library/html.rst | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/Doc/library/html.rst b/Doc/library/html.rst index 9aa39ba9a42b0f..65c49a4107a048 100644 --- a/Doc/library/html.rst +++ b/Doc/library/html.rst @@ -14,9 +14,12 @@ This module defines utilities to manipulate HTML. Convert the characters ``&``, ``<`` and ``>`` in string *s* to HTML-safe sequences. Use this if you need to display text that might contain such - characters in HTML. If the optional flag *quote* is true, the characters - (``"``) and (``'``) are also translated; this helps for inclusion in an HTML - attribute value delimited by quotes, as in ````. + characters in HTML. If the optional flag *quote* is true (the default), the + characters (``"``) and (``'``) are also translated; this helps for inclusion + in an HTML attribute value delimited by quotes, as in ````. + If *quote* is set to false, the characters (``"``) and (``'``) are not + translated. + .. versionadded:: 3.2