summaryrefslogtreecommitdiffstats
path: root/Doc/api/concrete.tex
diff options
context:
space:
mode:
authorWalter Dörwald <walter@livinglogic.de>2007-05-03 15:13:55 (GMT)
committerWalter Dörwald <walter@livinglogic.de>2007-05-03 15:13:55 (GMT)
commit27f4abf3b16ab818eae765439341139babc9ea31 (patch)
tree99a329539c464cf80fd95fd196a2caa8cccea6d1 /Doc/api/concrete.tex
parent9b73d0aed5e398b83669b4ab5c6f806369d37688 (diff)
downloadcpython-27f4abf3b16ab818eae765439341139babc9ea31.zip
cpython-27f4abf3b16ab818eae765439341139babc9ea31.tar.gz
cpython-27f4abf3b16ab818eae765439341139babc9ea31.tar.bz2
Clarify the behaviour of PyUnicode_DecodeUTF16(): A BOM is only skipped
in native order mode, and only if it's the first two bytes.
Diffstat (limited to 'Doc/api/concrete.tex')
-rw-r--r--Doc/api/concrete.tex8
1 files changed, 4 insertions, 4 deletions
diff --git a/Doc/api/concrete.tex b/Doc/api/concrete.tex
index 10f898e..b5622cc 100644
--- a/Doc/api/concrete.tex
+++ b/Doc/api/concrete.tex
@@ -1178,10 +1178,10 @@ These are the UTF-16 codec APIs:
*byteorder == 1: big endian
\end{verbatim}
- and then switches according to all byte order marks (BOM) it finds
- in the input data. BOMs are not copied into the resulting Unicode
- string. After completion, \var{*byteorder} is set to the current
- byte order at the end of input data.
+ and then switches if the first two bytes of the input data are a byte order
+ mark (BOM) and the specified byte order is native order. This BOM is not
+ copied into the resulting Unicode string. After completion, \var{*byteorder}
+ is set to the current byte order at the.
If \var{byteorder} is \NULL{}, the codec starts in native order mode.