traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Bug #805015: doc error in PyUnicode_FromEncodedObject.

This commit is contained in:
Georg Brandl 2006-06-14 16:46:43 +00:00
parent 7259d7bfd6
commit 69f6168b76
1 changed files with 7 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
Doc/api/concrete.tex
View File

@ -1001,21 +1001,14 @@ use these APIs:
const char *errors}
Coerce an encoded object \var{obj} to an Unicode object and return a
reference with incremented refcount.
String and other char buffer compatible objects are decoded
according to the given encoding and using the error handling
defined by errors. Both can be \NULL{} to have the interface
use the default values (see the next section for details).
Coercion is done in the following way:
\begin{enumerate}
\item Unicode objects are passed back as-is with incremented
refcount. \note{These cannot be decoded; passing a non-\NULL{}
value for encoding will result in a \exception{TypeError}.}
\item String and other char buffer compatible objects are decoded
according to the given encoding and using the error handling
defined by errors. Both can be \NULL{} to have the interface
use the default values (see the next section for details).
\item All other objects cause an exception.
\end{enumerate}
All other objects, including Unicode objects, cause a
\exception{TypeError} to be set.
The API returns \NULL{} if there was an error. The caller is
responsible for decref'ing the returned objects.