summaryrefslogtreecommitdiff
path: root/Doc/extending
diff options
context:
space:
mode:
authorR David Murray <rdmurray@bitdance.com>2015-04-12 21:52:12 -0400
committerR David Murray <rdmurray@bitdance.com>2015-04-12 21:52:12 -0400
commite6d3abd4524fffaa96a7dae4b861b21dd4d87e22 (patch)
tree219c851400a44649796b41a52790a6ac26012fbe /Doc/extending
parente81a773352bdfae94856f69b54f0e37917bd688b (diff)
parent354c7403c52cc7e46a69c5556107745e5ec91720 (diff)
downloadcpython-git-e6d3abd4524fffaa96a7dae4b861b21dd4d87e22.tar.gz
Merge: #17380: Document tp_init return value in extending docs.
Diffstat (limited to 'Doc/extending')
-rw-r--r--Doc/extending/newtypes.rst3
1 files changed, 2 insertions, 1 deletions
diff --git a/Doc/extending/newtypes.rst b/Doc/extending/newtypes.rst
index d52070221e..aaa37b8324 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