commit e3979f776a3837716aa7e566e388332d85314ceb
author Georg Brandl <georg@python.org> Sat Jan 19 20:40:24 2008 +0000
committer Georg Brandl <georg@python.org> Sat Jan 19 20:40:24 2008 +0000
tree 527d7c3f96ea787e82da82bee3ab65a22a49e7c9
parent 309501a61772f4cb72f1004fcbe73964b4130672

#1411695: clarify behavior of xml.sax.utils.[un]escape.

Doc/library/xml.sax.utils.rst

diff --git a/Doc/library/xml.sax.utils.rst b/Doc/library/xml.sax.utils.rst
index 0585a9b..c796ca8 100644
--- a/Doc/library/xml.sax.utils.rst
+++ b/Doc/library/xml.sax.utils.rst
@@ -21,7 +21,8 @@
 
    You can escape other strings of data by passing a dictionary as the optional
    *entities* parameter.  The keys and values must all be strings; each key will be
-   replaced with its corresponding value.
+   replaced with its corresponding value.  The characters ``'&'``, ``'<'`` and
+   ``'>'`` are always escaped, even if *entities* is provided.
 
 
 .. function:: unescape(data[, entities])
@@ -30,7 +31,8 @@
 
    You can unescape other strings of data by passing a dictionary as the optional
    *entities* parameter.  The keys and values must all be strings; each key will be
-   replaced with its corresponding value.
+   replaced with its corresponding value.  ``'&amp'``, ``'&lt;'``, and ``'&gt;'``
+   are always unescaped, even if *entities* is provided.
 
    .. versionadded:: 2.3