Bring cgi.escape docstring slightly more in line with the library ref

manual.  Closes #1243553.
This commit is contained in:
Skip Montanaro 2005-08-02 02:50:25 +00:00
parent 0d6615fd29
commit 97b2fa229c
1 changed files with 3 additions and 1 deletions

View File

@ -1041,7 +1041,9 @@ environment as well. Here are some common variable names:
# =========
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;")