Commit 57dd79e6 authored by Serhiy Storchaka's avatar Serhiy Storchaka Committed by GitHub

Fix documented signatures for C API functions. (GH-11236)

parent bf99bcf5
...@@ -209,7 +209,7 @@ type. ...@@ -209,7 +209,7 @@ type.
This function "steals" a reference to *o*. This function "steals" a reference to *o*.
.. c:function:: PyObject* PyStructSequence_SET_ITEM(PyObject *p, Py_ssize_t *pos, PyObject *o) .. c:function:: void PyStructSequence_SET_ITEM(PyObject *p, Py_ssize_t *pos, PyObject *o)
Macro equivalent of :c:func:`PyStructSequence_SetItem`. Macro equivalent of :c:func:`PyStructSequence_SetItem`.
......
...@@ -935,7 +935,7 @@ wchar_t Support ...@@ -935,7 +935,7 @@ wchar_t Support
Return *NULL* on failure. Return *NULL* on failure.
.. c:function:: Py_ssize_t PyUnicode_AsWideChar(PyUnicodeObject *unicode, wchar_t *w, Py_ssize_t size) .. c:function:: Py_ssize_t PyUnicode_AsWideChar(PyObject *unicode, wchar_t *w, Py_ssize_t size)
Copy the Unicode object contents into the :c:type:`wchar_t` buffer *w*. At most Copy the Unicode object contents into the :c:type:`wchar_t` buffer *w*. At most
*size* :c:type:`wchar_t` characters are copied (excluding a possibly trailing *size* :c:type:`wchar_t` characters are copied (excluding a possibly trailing
...@@ -1346,7 +1346,7 @@ These are the "Raw Unicode Escape" codec APIs: ...@@ -1346,7 +1346,7 @@ These are the "Raw Unicode Escape" codec APIs:
.. c:function:: PyObject* PyUnicode_EncodeRawUnicodeEscape(const Py_UNICODE *s, \ .. c:function:: PyObject* PyUnicode_EncodeRawUnicodeEscape(const Py_UNICODE *s, \
Py_ssize_t size, const char *errors) Py_ssize_t size)
Encode the :c:type:`Py_UNICODE` buffer of the given *size* using Raw-Unicode-Escape Encode the :c:type:`Py_UNICODE` buffer of the given *size* using Raw-Unicode-Escape
and return a bytes object. Return *NULL* if an exception was raised by the codec. and return a bytes object. Return *NULL* if an exception was raised by the codec.
...@@ -1515,8 +1515,8 @@ the user settings on the machine running the codec. ...@@ -1515,8 +1515,8 @@ the user settings on the machine running the codec.
Return *NULL* if an exception was raised by the codec. Return *NULL* if an exception was raised by the codec.
.. c:function:: PyObject* PyUnicode_DecodeMBCSStateful(const char *s, int size, \ .. c:function:: PyObject* PyUnicode_DecodeMBCSStateful(const char *s, Py_ssize_t size, \
const char *errors, int *consumed) const char *errors, Py_ssize_t *consumed)
If *consumed* is *NULL*, behave like :c:func:`PyUnicode_DecodeMBCS`. If If *consumed* is *NULL*, behave like :c:func:`PyUnicode_DecodeMBCS`. If
*consumed* is not *NULL*, :c:func:`PyUnicode_DecodeMBCSStateful` will not decode *consumed* is not *NULL*, :c:func:`PyUnicode_DecodeMBCSStateful` will not decode
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment