summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2010-08-02 21:51:51 (GMT)
committerGeorg Brandl <georg@python.org>2010-08-02 21:51:51 (GMT)
commit290142680b6d5792ef9e0d37d673e6b72d4690d2 (patch)
treed47911b876c72e7656d5ba66ac69123c47f939ec
parent3db92e9494947264899cfb6f5392d8640f0bada3 (diff)
downloadcpython-290142680b6d5792ef9e0d37d673e6b72d4690d2.zip
cpython-290142680b6d5792ef9e0d37d673e6b72d4690d2.tar.gz
cpython-290142680b6d5792ef9e0d37d673e6b72d4690d2.tar.bz2
Merged revisions 83599 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k ........ r83599 | georg.brandl | 2010-08-02 23:51:18 +0200 (Mo, 02 Aug 2010) | 1 line #9061: warn that single quotes are never escaped. ........
-rw-r--r--Doc/library/cgi.rst11
1 files changed, 7 insertions, 4 deletions
diff --git a/Doc/library/cgi.rst b/Doc/library/cgi.rst
index efee711..f0c0a07 100644
--- a/Doc/library/cgi.rst
+++ b/Doc/library/cgi.rst
@@ -349,10 +349,13 @@ algorithms implemented in this module in other circumstances.
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 quotation mark
- character (``'"'``) is also translated; this helps for inclusion in an HTML
- attribute value, as in ``<A HREF="...">``. If the value to be quoted might
- include single- or double-quote characters, or both, consider using the
- :func:`quoteattr` function in the :mod:`xml.sax.saxutils` module instead.
+ character (``"``) is also translated; this helps for inclusion in an HTML
+ attribute value delimited by double quotes, as in ``<a href="...">``. Note
+ that single quotes are never translated.
+
+ If the value to be quoted might include single- or double-quote characters,
+ or both, consider using the :func:`quoteattr` function in the
+ :mod:`xml.sax.saxutils` module instead.
.. _cgi-security: