mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-11-03 19:34:08 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 9

Issue #28750: Fixed docs of of unicode-escape an raw-unicode-escape C API.

Browse source 
Patch by Xiang Zhang.
This commit is contained in:
Serhiy Storchaka 2016-11-20 17:21:04 +02:00
commit 01452af645
1 changed files with 5 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

12
Doc/c-api/unicode.rst
View file

@ -1296,16 +1296,15 @@ These are the "Unicode Escape" codec APIs:
.. c:function:: PyObject* PyUnicode_AsUnicodeEscapeString(PyObject *unicode) .. c:function:: PyObject* PyUnicode_AsUnicodeEscapeString(PyObject *unicode)
Encode a Unicode object using Unicode-Escape and return the result as Python Encode a Unicode object using Unicode-Escape and return the result as a
string object. Error handling is "strict". Return *NULL* if an exception was bytes object. Error handling is "strict". Return *NULL* if an exception was
raised by the codec. raised by the codec.
.. c:function:: PyObject* PyUnicode_EncodeUnicodeEscape(const Py_UNICODE *s, Py_ssize_t size) .. 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 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 return a bytes object. Return *NULL* if an exception was raised by the codec.
codec.
.. deprecated-removed:: 3.3 4.0 .. deprecated-removed:: 3.3 4.0
Part of the old-style :c:type:`Py_UNICODE` API; please migrate to using 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) .. c:function:: PyObject* PyUnicode_AsRawUnicodeEscapeString(PyObject *unicode)
Encode a Unicode object using Raw-Unicode-Escape and return the result as 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. was raised by the codec.
@ -1336,8 +1335,7 @@ These are the "Raw Unicode Escape" codec APIs:
Py_ssize_t size, const char *errors) Py_ssize_t size, const char *errors)
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 Python string object. Return *NULL* if an exception was raised by and return a bytes object. Return *NULL* if an exception was raised by the codec.
the codec.
.. deprecated-removed:: 3.3 4.0 .. deprecated-removed:: 3.3 4.0
Part of the old-style :c:type:`Py_UNICODE` API; please migrate to using Part of the old-style :c:type:`Py_UNICODE` API; please migrate to using