commit 97b2fa229c219652b83fb22670f1b6af4d3a18c3
author Skip Montanaro <skip@pobox.com> Tue Aug 02 02:50:25 2005 +0000
committer Skip Montanaro <skip@pobox.com> Tue Aug 02 02:50:25 2005 +0000
tree 845fa08f4aeb3cfa34e76cc01a1b795f49a3b913
parent 0d6615fd29063bdaccb13e1fbae542fb666d8728

Bring cgi.escape docstring slightly more in line with the library ref
manual.  Closes #1243553.

Lib/cgi.py

diff --git a/Lib/cgi.py b/Lib/cgi.py
index 1a99868..eb96303 100755
--- a/Lib/cgi.py
+++ b/Lib/cgi.py
@@ -1041,7 +1041,9 @@
 # =========
 
 def escape(s, quote=None):
-    """Replace special characters '&', '<' and '>' by SGML entities."""
+    '''Replace special characters "&", "<" and ">" to HTML-safe sequences.
+    If the optional flag quote is true, the quotation mark character (")
+    is also translated.'''
     s = s.replace("&", "&amp;") # Must be done first!
     s = s.replace("<", "&lt;")
     s = s.replace(">", "&gt;")