From: Guido van Rossum <guido@python.org>
Date: Sat, 19 Jul 1997 20:16:07 +0000 (+0000)
Subject: Document new 'quote' flag to cgi.escape().
X-Git-Tag: v1.5a3~207
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=6576dd6ad6fed997ef3e622cad390ce8c9311200;p=python

Document new 'quote' flag to cgi.escape().
---

diff --git a/Doc/lib/libcgi.tex b/Doc/lib/libcgi.tex
index 56643d05fc..4d0c5d6dcd 100644
--- a/Doc/lib/libcgi.tex
+++ b/Doc/lib/libcgi.tex
@@ -219,10 +219,12 @@ content-type and a dictionary of parameters.
 HTML.
 \end{funcdesc}
 
-\begin{funcdesc}{escape}{}: convert the characters ``\code{\&}'', ``\code{<}'' and ``\code{>}'' to HTML-safe
+\begin{funcdesc}{escape}{s\optional{\, quote}}: convert the characters
+``\code{\&}'', ``\code{<}'' and ``\code{>}'' in string \var{s} to HTML-safe
 sequences.  Use this if you need to display text that might contain
-such characters in HTML.  To translate URLs for inclusion in the HREF
-attribute of an \code{<A>} tag, use \code{urllib.quote()}.
+such characters in HTML.  If the optional flag \var{quote} is true,
+the double quote character (\code{"}) is also translated; this helps
+for inclusion in an HTML attribute value, e.g. in ``\code{<A HREF="...">}''.
 \end{funcdesc}
 
 
diff --git a/Doc/libcgi.tex b/Doc/libcgi.tex
index 56643d05fc..4d0c5d6dcd 100644
--- a/Doc/libcgi.tex
+++ b/Doc/libcgi.tex
@@ -219,10 +219,12 @@ content-type and a dictionary of parameters.
 HTML.
 \end{funcdesc}
 
-\begin{funcdesc}{escape}{}: convert the characters ``\code{\&}'', ``\code{<}'' and ``\code{>}'' to HTML-safe
+\begin{funcdesc}{escape}{s\optional{\, quote}}: convert the characters
+``\code{\&}'', ``\code{<}'' and ``\code{>}'' in string \var{s} to HTML-safe
 sequences.  Use this if you need to display text that might contain
-such characters in HTML.  To translate URLs for inclusion in the HREF
-attribute of an \code{<A>} tag, use \code{urllib.quote()}.
+such characters in HTML.  If the optional flag \var{quote} is true,
+the double quote character (\code{"}) is also translated; this helps
+for inclusion in an HTML attribute value, e.g. in ``\code{<A HREF="...">}''.
 \end{funcdesc}