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

This commit is contained in:
Guido van Rossum 1997-07-19 20:16:07 +00:00
parent 64c6620934
commit 6576dd6ad6
2 changed files with 10 additions and 6 deletions

View File

@ -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}

View File

@ -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}