diff options
| author | Serhiy Storchaka <storchaka@gmail.com> | 2016-11-20 17:21:38 +0200 |
|---|---|---|
| committer | Serhiy Storchaka <storchaka@gmail.com> | 2016-11-20 17:21:38 +0200 |
| commit | f0a6d34f36934699b5746df7c1f9ee3e18ee5eeb (patch) | |
| tree | 137115ef504be3a1e2d515ee27d8ae0467ee48ea | |
| parent | c34a59009215b673a6439ea000c1bf81ed983be8 (diff) | |
| parent | 01452af645d6b6465a8a2bcedec042848af14104 (diff) | |
| download | cpython-git-f0a6d34f36934699b5746df7c1f9ee3e18ee5eeb.tar.gz | |
Issue #28750: Fixed docs of of unicode-escape an raw-unicode-escape C API.
Patch by Xiang Zhang.
| -rw-r--r-- | Doc/c-api/unicode.rst | 12 |
1 files changed, 5 insertions, 7 deletions
diff --git a/Doc/c-api/unicode.rst b/Doc/c-api/unicode.rst index b851090fce..fc91d0cac5 100644 --- a/Doc/c-api/unicode.rst +++ b/Doc/c-api/unicode.rst @@ -1296,16 +1296,15 @@ These are the "Unicode Escape" codec APIs: .. c:function:: PyObject* PyUnicode_AsUnicodeEscapeString(PyObject *unicode) - Encode a Unicode object using Unicode-Escape and return the result as Python - string object. Error handling is "strict". Return *NULL* if an exception was + Encode a Unicode object using Unicode-Escape and return the result as a + bytes object. Error handling is "strict". Return *NULL* if an exception was raised by the codec. .. c:function:: PyObject* PyUnicode_EncodeUnicodeEscape(const Py_UNICODE *s, Py_ssize_t size) Encode the :c:type:`Py_UNICODE` buffer of the given *size* using Unicode-Escape and - return a Python string object. Return *NULL* if an exception was raised by the - codec. + return a bytes object. Return *NULL* if an exception was raised by the codec. .. deprecated-removed:: 3.3 4.0 Part of the old-style :c:type:`Py_UNICODE` API; please migrate to using @@ -1328,7 +1327,7 @@ These are the "Raw Unicode Escape" codec APIs: .. c:function:: PyObject* PyUnicode_AsRawUnicodeEscapeString(PyObject *unicode) Encode a Unicode object using Raw-Unicode-Escape and return the result as - Python string object. Error handling is "strict". Return *NULL* if an exception + a bytes object. Error handling is "strict". Return *NULL* if an exception was raised by the codec. @@ -1336,8 +1335,7 @@ These are the "Raw Unicode Escape" codec APIs: Py_ssize_t size, const char *errors) Encode the :c:type:`Py_UNICODE` buffer of the given *size* using Raw-Unicode-Escape - and return a Python string 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. .. deprecated-removed:: 3.3 4.0 Part of the old-style :c:type:`Py_UNICODE` API; please migrate to using |