https://github.com/python/cpython/commit/1ef6e8ca3faf2c2b008fb170c7c44c38b86e874a
commit: 1ef6e8ca3faf2c2b008fb170c7c44c38b86e874a
branch: main
author: Victor Stinner <[email protected]>
committer: vstinner <[email protected]>
date: 2024-12-05T10:37:14+01:00
summary:
gh-119182: Complete PyUnicodeWriter documentation (#127607)
files:
M Doc/c-api/unicode.rst
diff --git a/Doc/c-api/unicode.rst b/Doc/c-api/unicode.rst
index 59bd7661965d93..dcbc8804cd6b89 100644
--- a/Doc/c-api/unicode.rst
+++ b/Doc/c-api/unicode.rst
@@ -1588,6 +1588,11 @@ object.
Create a Unicode writer instance.
+ *length* must be greater than or equal to ``0``.
+
+ If *length* is greater than ``0``, preallocate an internal buffer of
+ *length* characters.
+
Set an exception and return ``NULL`` on error.
.. c:function:: PyObject* PyUnicodeWriter_Finish(PyUnicodeWriter *writer)
@@ -1596,12 +1601,16 @@ object.
Set an exception and return ``NULL`` on error.
+ The writer instance is invalid after this call.
+
.. c:function:: void PyUnicodeWriter_Discard(PyUnicodeWriter *writer)
Discard the internal Unicode buffer and destroy the writer instance.
If *writer* is ``NULL``, no operation is performed.
+ The writer instance is invalid after this call.
+
.. c:function:: int PyUnicodeWriter_WriteChar(PyUnicodeWriter *writer, Py_UCS4
ch)
Write the single Unicode character *ch* into *writer*.
_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: [email protected]
