[Python-checkins] Add the meaning of the returned value of PyTypeObject.tp_init (GH-12325)

[Miss Islington (bot)]

https://github.com/python/cpython/commit/7c4fcb6b05792e94dd5f8aca032f01314248f5ac
commit: 7c4fcb6b05792e94dd5f8aca032f01314248f5ac
branch: master
author: Stéphane Wirtel <stephane at wirtel.be>
committer: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
date: 2019-03-15T09:18:36-07:00
summary:

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

files:
M Doc/c-api/typeobj.rst

diff --git a/Doc/c-api/typeobj.rst b/Doc/c-api/typeobj.rst
index 5615f59514b9..f36cfe551e4c 100644
--- 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.