gh-139006: Doc: Clarify html.escape function description (#139016)

Doc: Clarify html.escape function description (GH-139006)

diff --git a/Doc/library/html.rst b/Doc/library/html.rst
index 9aa39ba9a42b0fdb4cadf0940c01cedb73ac10cc..65c49a4107a0487db221561425412304540b1e79 100644 (file)
--- 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 ``<a href="...">``.
+   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 ``<a href="...">``.
+   If *quote* is set to false, the characters (``"``) and (``'``) are not
+   translated.
+
 
    .. versionadded:: 3.2