From: Walter Dörwald <walter@livinglogic.de>
Date: Thu, 3 May 2007 15:13:55 +0000 (+0000)
Subject: Clarify the behaviour of PyUnicode_DecodeUTF16(): A BOM is only skipped
X-Git-Tag: v2.6a1~1779
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=27f4abf3b16ab818eae765439341139babc9ea31;p=thirdparty%2FPython%2Fcpython.git

Clarify the behaviour of PyUnicode_DecodeUTF16(): A BOM is only skipped
in native order mode, and only if it's the first two bytes.
---

diff --git a/Doc/api/concrete.tex b/Doc/api/concrete.tex
index 10f898ea9478..b5622cce9287 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.