From: Brian Curtin <brian@python.org>
Date: Thu, 11 Aug 2011 14:41:31 +0000 (-0500)
Subject: Add doc for Py_RETURN_NOTIMPLEMENTED, added in #12724.
X-Git-Tag: v3.3.0a1~1714^2~1
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=49281076c1dcc3d8d7b5592a49dd9c65c1e6b8a4;p=thirdparty%2FPython%2Fcpython.git

Add doc for Py_RETURN_NOTIMPLEMENTED, added in #12724.
---

diff --git a/Doc/c-api/object.rst b/Doc/c-api/object.rst
index d0d45ad0012b..88ba5ac0c4ef 100644
--- a/Doc/c-api/object.rst
+++ b/Doc/c-api/object.rst
@@ -6,6 +6,19 @@ Object Protocol
 ===============
 
 
+.. c:var:: PyObject* Py_NotImplemented
+
+   The ``NotImplemented`` singleton, used to signal that an operation is
+   not implemented for the given type combination.
+
+
+.. c:macro:: Py_RETURN_NOTIMPLEMENTED
+
+   Properly handle returning :c:data:`Py_NotImplemented` from within a C
+   function (that is, increment the reference count of NotImplemented and
+   return it).
+
+
 .. c:function:: int PyObject_Print(PyObject *o, FILE *fp, int flags)
 
    Print an object *o*, on file *fp*.  Returns ``-1`` on error.  The flags argument