[Python-checkins] r60099 - python/trunk/Doc/library/xml.sax.utils.rst

Sat Jan 19 21:40:25 CET 2008

Author: georg.brandl
Date: Sat Jan 19 21:40:24 2008
New Revision: 60099
Modified:
 python/trunk/Doc/library/xml.sax.utils.rst
Log:
#1411695: clarify behavior of xml.sax.utils.[un]escape.
Modified: python/trunk/Doc/library/xml.sax.utils.rst
==============================================================================

--- python/trunk/Doc/library/xml.sax.utils.rst	(original)
+++ python/trunk/Doc/library/xml.sax.utils.rst	Sat Jan 19 21:40:24 2008
@@ -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
 
