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

Doc: Clarify html.escape function description (GH-139006)
2025-12-23 09:19:18 +00:00 · 2025-09-17 19:15:34 +05:30 · 2025-09-17 19:15:34 +05:30 · 81c975bcfc
commit 81c975bcfc
parent 5df6a568e1
1 changed files with 6 additions and 3 deletions
--- 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