Skip to content

Commit fb8d604

Browse files
[3.12] GH-95079: document error behaviour for some unicode C APIs (GH-95080) (#124662)
(cherry picked from commit b79a21e) Co-authored-by: Max Bachmann <kontakt@maxbachmann.de>
1 parent 4d38254 commit fb8d604

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

Doc/c-api/unicode.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -345,6 +345,8 @@ APIs:
345345
This is the recommended way to allocate a new Unicode object. Objects
346346
created using this function are not resizable.
347347
348+
On error, set an exception and return ``NULL``.
349+
348350
.. versionadded:: 3.3
349351
350352
@@ -598,6 +600,8 @@ APIs:
598600
599601
Return the length of the Unicode object, in code points.
600602
603+
On error, set an exception and return ``-1``.
604+
601605
.. versionadded:: 3.3
602606
603607
@@ -641,6 +645,8 @@ APIs:
641645
not out of bounds, and that the object can be modified safely (i.e. that it
642646
its reference count is one).
643647
648+
Return ``0`` on success, ``-1`` on error with an exception set.
649+
644650
.. versionadded:: 3.3
645651
646652
@@ -650,6 +656,8 @@ APIs:
650656
Unicode object and the index is not out of bounds, in contrast to
651657
:c:func:`PyUnicode_READ_CHAR`, which performs no error checking.
652658
659+
Return character on success, ``-1`` on error with an exception set.
660+
653661
.. versionadded:: 3.3
654662
655663
@@ -658,6 +666,7 @@ APIs:
658666
659667
Return a substring of *unicode*, from character index *start* (included) to
660668
character index *end* (excluded). Negative indices are not supported.
669+
On error, set an exception and return ``NULL``.
661670
662671
.. versionadded:: 3.3
663672

0 commit comments

Comments
 (0)