classification
Title: [PATCH] PyUnicode_DecodeUTF16 docs wrong (byteorder param)
Type: behavior Stage:
Components: Documentation Versions: Python 2.7, Python 2.6
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: georg.brandl Nosy List: JonFoster, georg.brandl
Priority: normal Keywords: patch

Created on 2009-09-17 14:09 by JonFoster, last changed 2009-09-18 21:36 by georg.brandl. This issue is now closed.

Files
File name Uploaded Description Edit
unicodedocs.patch JonFoster, 2009-09-17 14:09 Patch v1
Messages (2)
msg92764 - (view) Author: Jon Foster (JonFoster) Date: 2009-09-17 14:09
The documentation for the C API function PyUnicode_DecodeUTF16() does
not match the code.

If *byteorder is 1 or -1, the documentation says that the function looks
for a BOM.  It doesn't.  This patch updates the documentation to match
the code.

(Also, I just realised that the docs for PyUnicode_DecodeUTF32() have
the exact same bug.  That is NOT fixed by this patch).

This patch also clarifies the PyUnicode_EncodeUTF16() docs.
msg92848 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2009-09-18 21:36
I applied a slightly different patch in r74933.
History
Date User Action Args
2009-09-18 21:36:13georg.brandlsetstatus: open -> closed
resolution: fixed
messages: + msg92848
2009-09-17 14:09:58JonFostercreate