bpo-39560: Document PyUnicode_FromKindAndData() kind transformation

This commit is contained in:
Zackery Spytz 2020-12-18 14:22:34 -07:00
parent e8d2264210
commit c824a20c53
1 changed files with 6 additions and 0 deletions

View File

@ -422,6 +422,12 @@ APIs:
:c:func:`PyUnicode_KIND`). The *buffer* must point to an array of *size*
units of 1, 2 or 4 bytes per character, as given by the kind.
If necessary, the input *buffer* is copied and transformed into the
canonical representation. For example, if the *buffer* is a UCS4 string
(:c:macro:`PyUnicode_4BYTE_KIND`) and it consists only of codepoints in
the UCS1 range, it will be transformed into UCS1
(:c:macro:`PyUnicode_1BYTE_KIND`).
.. versionadded:: 3.3