summaryrefslogtreecommitdiffstats
path: root/Doc/c-api/number.rst
diff options
context:
space:
mode:
Diffstat (limited to 'Doc/c-api/number.rst')
-rw-r--r--Doc/c-api/number.rst6
1 files changed, 6 insertions, 0 deletions
diff --git a/Doc/c-api/number.rst b/Doc/c-api/number.rst
index e7c5f61..c8f6945 100644
--- a/Doc/c-api/number.rst
+++ b/Doc/c-api/number.rst
@@ -233,6 +233,12 @@ Number Protocol
Returns the *o* converted to an integer object on success, or *NULL* on
failure. This is the equivalent of the Python expression ``int(o)``.
+ .. note::
+
+ This function is defined in the transitional :file:`intobject.h`
+ header file. It will be removed completely in Python 3.1. Use
+ the :cfunc:`PyNumber_Long` function instead.
+
.. cfunction:: PyObject* PyNumber_Long(PyObject *o)