From 354c7403c52cc7e46a69c5556107745e5ec91720 Mon Sep 17 00:00:00 2001 From: R David Murray Date: Sun, 12 Apr 2015 21:51:36 -0400 Subject: #17380: Document tp_init return value in extending docs. Patch by James Powell. --- Doc/extending/newtypes.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Doc/extending/newtypes.rst b/Doc/extending/newtypes.rst index d520702..aaa37b8 100644 --- 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 -- cgit v0.12