]> granicus.if.org Git - python/commitdiff
#1411695: clarify behavior of xml.sax.utils.[un]escape.
authorGeorg Brandl <georg@python.org>
Sat, 19 Jan 2008 20:40:24 +0000 (20:40 +0000)
committerGeorg Brandl <georg@python.org>
Sat, 19 Jan 2008 20:40:24 +0000 (20:40 +0000)
Doc/library/xml.sax.utils.rst

index 0585a9bfe1ee41f1670988280fb0fc8fbc204b33..c796ca8c86e958e101f2400795cba8f85b4f16b1 100644 (file)
@@ -21,7 +21,8 @@ or as base classes.
 
    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 @@ or as base classes.
 
    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