Add the meaning of the returned value of PyTypeObject.tp_init (GH-12325)

diff --git a/Doc/c-api/typeobj.rst b/Doc/c-api/typeobj.rst
index 5615f59514b9de907c53bc6cf709b53141ae4982..f36cfe551e4cc858293e130032dffbe0d6dd0a92 100644 (file)
--- a/Doc/c-api/typeobj.rst
+++ b/Doc/c-api/typeobj.rst
@@ -1558,6 +1558,8 @@ and :c:type:`PyType_Type` effectively act as defaults.)
    :c:member:`~PyTypeObject.tp_init` function is called; if :c:member:`~PyTypeObject.tp_new` returns an instance of a
    subtype of the original type, the subtype's :c:member:`~PyTypeObject.tp_init` is called.
 
+   Returns ``0`` on success, ``-1`` and sets an exception on error.
+
    **Inheritance:**
 
    This field is inherited by subtypes.