From: Fred Drake <fdrake@acm.org>
Date: Mon, 10 Dec 2001 16:43:08 +0000 (+0000)
Subject: Added documentation for str.decode().
X-Git-Tag: v2.2.1c1~442
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=6048ce95a94ee4527799d7c2fe43ffa43fa64990;p=python

Added documentation for str.decode().
This closes SF bug #490823.
---

diff --git a/Doc/lib/libstdtypes.tex b/Doc/lib/libstdtypes.tex
index ed0c4d90f1..a92928eebd 100644
--- a/Doc/lib/libstdtypes.tex
+++ b/Doc/lib/libstdtypes.tex
@@ -502,6 +502,16 @@ S\code{[\var{start}:\var{end}]}.  Optional arguments \var{start} and
 \var{end} are interpreted as in slice notation.
 \end{methoddesc}
 
+\begin{methoddesc}[string]{decode}{\optional{encoding\optional{, errors}}}
+Decodes the string using the codec registered for \var{encoding}.
+\var{encoding} defaults to the default string encoding.  \var{errors}
+may be given to set a different error handling scheme.  The default is
+\code{'strict'}, meaning that encoding errors raise
+\exception{ValueError}.  Other possible values are \code{'ignore'} and
+\code{replace'}.
+\versionadded{2.2}
+\end{methoddesc}
+
 \begin{methoddesc}[string]{encode}{\optional{encoding\optional{,errors}}}
 Return an encoded version of the string.  Default encoding is the current
 default string encoding.  \var{errors} may be given to set a different