bpo-39560: Document PyUnicode_FromKindAndData() kind transformation (GH-23848)

This commit is contained in:
Zackery Spytz 2021-06-03 06:33:44 -07:00 committed by GitHub
parent 8b93f0e696
commit 4eed2821d4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -421,6 +421,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