summaryrefslogtreecommitdiffstats
path: root/Doc/library/html.rst
diff options
context:
space:
mode:
Diffstat (limited to 'Doc/library/html.rst')
-rw-r--r--Doc/library/html.rst21
1 files changed, 21 insertions, 0 deletions
diff --git a/Doc/library/html.rst b/Doc/library/html.rst
new file mode 100644
index 0000000..0063db6
--- /dev/null
+++ b/Doc/library/html.rst
@@ -0,0 +1,21 @@
+:mod:`html` --- HyperText Markup Language support
+=================================================
+
+.. module:: html
+ :synopsis: Helpers for manipulating HTML.
+
+.. versionadded:: 3.2
+
+**Source code:** :source:`Lib/html/__init__.py`
+
+--------------
+
+This module defines utilities to manipulate HTML.
+
+.. function:: escape(s, quote=True)
+
+ 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="...">``.