summaryrefslogtreecommitdiffstats
path: root/Doc/lib
diff options
context:
space:
mode:
authorMartin v. Löwis <martin@v.loewis.de>2005-03-03 10:06:05 (GMT)
committerMartin v. Löwis <martin@v.loewis.de>2005-03-03 10:06:05 (GMT)
commit9b62b3907056bedc83e7a2198eec722c84d7c473 (patch)
treec5592c158047b7fcce9c2f2cde6c3cac3a2f441f /Doc/lib
parente869eb1953b1383c5fe4be7ac6d96245553ff1ba (diff)
downloadcpython-9b62b3907056bedc83e7a2198eec722c84d7c473.zip
cpython-9b62b3907056bedc83e7a2198eec722c84d7c473.tar.gz
cpython-9b62b3907056bedc83e7a2198eec722c84d7c473.tar.bz2
Document quiet parameter to decode. Fixes #803413.
Diffstat (limited to 'Doc/lib')
-rw-r--r--Doc/lib/libuu.tex6
1 files changed, 5 insertions, 1 deletions
diff --git a/Doc/lib/libuu.tex b/Doc/lib/libuu.tex
index adc3bbc..9adb4cf 100644
--- a/Doc/lib/libuu.tex
+++ b/Doc/lib/libuu.tex
@@ -31,13 +31,17 @@ The \module{uu} module defines the following functions:
respectively.
\end{funcdesc}
-\begin{funcdesc}{decode}{in_file\optional{, out_file\optional{, mode}}}
+\begin{funcdesc}{decode}{in_file\optional{, out_file\optional{, mode\optional{, quiet}}}}
This call decodes uuencoded file \var{in_file} placing the result on
file \var{out_file}. If \var{out_file} is a pathname, \var{mode} is
used to set the permission bits if the file must be
created. Defaults for \var{out_file} and \var{mode} are taken from
the uuencode header. However, if the file specified in the header
already exists, a \exception{uu.Error} is raised.
+
+ \function{decode} may print a warning to stderr if the input was produced
+ by an incorrect uuencoder and Python could recover from that error.
+ Setting \var{quiet} to True silences this warning.
\end{funcdesc}
\begin{excclassdesc}{Error}{}