summaryrefslogtreecommitdiffstats
path: root/Doc/api
diff options
context:
space:
mode:
Diffstat (limited to 'Doc/api')
-rw-r--r--Doc/api/concrete.tex7
-rw-r--r--Doc/api/utilities.tex12
2 files changed, 10 insertions, 9 deletions
diff --git a/Doc/api/concrete.tex b/Doc/api/concrete.tex
index 2c4d45f..c9ca1e7 100644
--- a/Doc/api/concrete.tex
+++ b/Doc/api/concrete.tex
@@ -1109,9 +1109,10 @@ These are the UTF-16 codec APIs:
the Unicode BOM mark (U+FEFF). In the other two modes, no BOM mark
is prepended.
- Note that \ctype{Py_UNICODE} data is being interpreted as UTF-16
- reduced to UCS-2. This trick makes it possible to add full UTF-16
- capabilities at a later point without comprimising the APIs.
+ If \var{Py_UNICODE_WIDE} is defined, a single \ctype{Py_UNICODE}
+ value may get represented as a surrogate pair. If it is not
+ defined, each \ctype{Py_UNICODE} values is interpreted as an
+ UCS-2 character.
Returns \NULL{} if an exception was raised by the codec.
\end{cfuncdesc}
diff --git a/Doc/api/utilities.tex b/Doc/api/utilities.tex
index 39ca932..f4fa899 100644
--- a/Doc/api/utilities.tex
+++ b/Doc/api/utilities.tex
@@ -780,14 +780,14 @@ PyArg_ParseTuple(args, "O|O:ref", &object, &callback)
Same as \samp{s\#}.
\item[\samp{u} (Unicode string) {[Py_UNICODE *]}]
- Convert a null-terminated buffer of Unicode (UCS-2) data to a
- Python Unicode object. If the Unicode buffer pointer is \NULL,
- \code{None} is returned.
+ Convert a null-terminated buffer of Unicode (UCS-2 or UCS-4)
+ data to a Python Unicode object. If the Unicode buffer pointer
+ is \NULL, \code{None} is returned.
\item[\samp{u\#} (Unicode string) {[Py_UNICODE *, int]}]
- Convert a Unicode (UCS-2) data buffer and its length to a Python
- Unicode object. If the Unicode buffer pointer is \NULL, the
- length is ignored and \code{None} is returned.
+ Convert a Unicode (UCS-2 or UCS-4) data buffer and its length
+ to a Python Unicode object. If the Unicode buffer pointer
+ is \NULL, the length is ignored and \code{None} is returned.
\item[\samp{i} (integer) {[int]}]
Convert a plain C \ctype{int} to a Python integer object.