#17380: Document tp_init return value in extending docs.

Patch by James Powell.

diff --git a/Doc/extending/newtypes.rst b/Doc/extending/newtypes.rst
index d52070221ea76d6ed7a425aad758a3facaa0c0bc..aaa37b8324986b289b62bb94a2da523533ad1575 100644 (file)
--- a/Doc/extending/newtypes.rst
+++ b/Doc/extending/newtypes.rst
@@ -383,7 +383,8 @@ is used to initialize an object after it's created. Unlike the new method, we
 can't guarantee that the initializer is called.  The initializer isn't called
 when unpickling objects and it can be overridden.  Our initializer accepts
 arguments to provide initial values for our instance. Initializers always accept
-positional and keyword arguments.
+positional and keyword arguments. Initializers should return either 0 on
+success or -1 on error.
 
 Initializers can be called multiple times.  Anyone can call the :meth:`__init__`
 method on our objects.  For this reason, we have to be extra careful when