From bd94554c553cdb9872645ebfb9a497fb20009e17 Mon Sep 17 00:00:00 2001 From: Inada Naoki Date: Thu, 27 Apr 2023 14:53:11 +0900 Subject: [PATCH] gh-103883: Doc: Move PyUnicode_FromObject doc (#103913) This API is one of Unicode creator APIs. (cherry picked from commit ce2383ec6665850a1bdffad388876481b6f3205f) --- Doc/c-api/unicode.rst | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/Doc/c-api/unicode.rst b/Doc/c-api/unicode.rst index e72f151510cbde..12f95a2e8a39d0 100644 --- a/Doc/c-api/unicode.rst +++ b/Doc/c-api/unicode.rst @@ -572,6 +572,15 @@ APIs: arguments. +.. c:function:: PyObject* PyUnicode_FromObject(PyObject *obj) + + Copy an instance of a Unicode subtype to a new true Unicode object if + necessary. If *obj* is already a true Unicode object (not a subtype), + return the reference with incremented refcount. + + Objects other than Unicode or its subtypes will cause a :exc:`TypeError`. + + .. c:function:: PyObject* PyUnicode_FromEncodedObject(PyObject *obj, \ const char *encoding, const char *errors) @@ -752,15 +761,6 @@ Extension modules can continue using them, as they will not be removed in Python :c:func:`PyUnicode_GET_LENGTH`. -.. c:function:: PyObject* PyUnicode_FromObject(PyObject *obj) - - Copy an instance of a Unicode subtype to a new true Unicode object if - necessary. If *obj* is already a true Unicode object (not a subtype), - return the reference with incremented refcount. - - Objects other than Unicode or its subtypes will cause a :exc:`TypeError`. - - Locale Encoding """""""""""""""