From: Georg Brandl Date: Wed, 14 Jun 2006 16:46:43 +0000 (+0000) Subject: Bug #805015: doc error in PyUnicode_FromEncodedObject. X-Git-Tag: v2.5b1~51 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=69f6168b766d3fb8fbd0dec8cbeaf97ce564e2c4;p=python Bug #805015: doc error in PyUnicode_FromEncodedObject. --- diff --git a/Doc/api/concrete.tex b/Doc/api/concrete.tex index 40b178fce1..f1fbccbe70 100644 --- a/Doc/api/concrete.tex +++ b/Doc/api/concrete.tex @@ -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. - - 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} + + 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). + + 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.