[issue6930] [PATCH] PyUnicode_DecodeUTF16 docs wrong (byteorder param)

[Jon Foster]

New submission from Jon Foster <jon.foster at cabot.co.uk>:

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.

----------
assignee: georg.brandl
components: Documentation
files: unicodedocs.patch
keywords: patch
messages: 92764
nosy: JonFoster, georg.brandl
severity: normal
status: open
title: [PATCH] PyUnicode_DecodeUTF16 docs wrong (byteorder param)
type: behavior
versions: Python 2.6, Python 2.7
Added file: http://bugs.python.org/file14910/unicodedocs.patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue6930>
_______________________________________