From 69f6168b766d3fb8fbd0dec8cbeaf97ce564e2c4 Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Wed, 14 Jun 2006 16:46:43 +0000 Subject: [PATCH] Bug #805015: doc error in PyUnicode_FromEncodedObject. --- Doc/api/concrete.tex | 21 +++++++-------------- 1 file changed, 7 insertions(+), 14 deletions(-) diff --git a/Doc/api/concrete.tex b/Doc/api/concrete.tex index 40b178fce1e..f1fbccbe70e 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. + + 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.