diff options
| author | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2018-12-20 13:34:21 -0800 |
|---|---|---|
| committer | Ned Deily <nad@python.org> | 2018-12-20 16:34:21 -0500 |
| commit | 3a26b59ed61c0779622f7184f440328858d5d23b (patch) | |
| tree | 5bf20b7eb35cd95f91358bce62888c7bd542f64c | |
| parent | ff740db42326082fac7d415ae9aff148628a83ed (diff) | |
| download | cpython-git-3a26b59ed61c0779622f7184f440328858d5d23b.tar.gz | |
Fix documented signatures for C API functions. (GH-11236) (GH-11240)
(cherry picked from commit 57dd79e6f7f33bb4e6817ac58c9cb91de99675e0)
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
| -rw-r--r-- | Doc/c-api/tuple.rst | 2 | ||||
| -rw-r--r-- | Doc/c-api/unicode.rst | 8 |
2 files changed, 5 insertions, 5 deletions
diff --git a/Doc/c-api/tuple.rst b/Doc/c-api/tuple.rst index 3922d50f80..ab8ee9abf4 100644 --- a/Doc/c-api/tuple.rst +++ b/Doc/c-api/tuple.rst @@ -209,7 +209,7 @@ type. 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`. diff --git a/Doc/c-api/unicode.rst b/Doc/c-api/unicode.rst index b9acaec949..55d5b070ff 100644 --- a/Doc/c-api/unicode.rst +++ b/Doc/c-api/unicode.rst @@ -925,7 +925,7 @@ wchar_t Support 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 *size* :c:type:`wchar_t` characters are copied (excluding a possibly trailing @@ -1324,7 +1324,7 @@ These are the "Raw Unicode Escape" codec APIs: .. 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 and return a bytes object. Return *NULL* if an exception was raised by the codec. @@ -1493,8 +1493,8 @@ the user settings on the machine running the codec. Return *NULL* if an exception was raised by the codec. -.. c:function:: PyObject* PyUnicode_DecodeMBCSStateful(const char *s, int size, \ - const char *errors, int *consumed) +.. c:function:: PyObject* PyUnicode_DecodeMBCSStateful(const char *s, Py_ssize_t size, \ + const char *errors, Py_ssize_t *consumed) If *consumed* is *NULL*, behave like :c:func:`PyUnicode_DecodeMBCS`. If *consumed* is not *NULL*, :c:func:`PyUnicode_DecodeMBCSStateful` will not decode |