summaryrefslogtreecommitdiffstats
path: root/Doc/c-api/capsule.rst
diff options
context:
space:
mode:
authorSerhiy Storchaka <storchaka@gmail.com>2016-10-27 18:41:19 (GMT)
committerSerhiy Storchaka <storchaka@gmail.com>2016-10-27 18:41:19 (GMT)
commit1ecf7d204dd3abb143f53851c31fefd4ef887314 (patch)
tree9cd727d732a82c41d4522b1fd405f408d4718f61 /Doc/c-api/capsule.rst
parentb29cee40ee948731f239cc3a200c62ea3dbabc9f (diff)
downloadcpython-1ecf7d204dd3abb143f53851c31fefd4ef887314.zip
cpython-1ecf7d204dd3abb143f53851c31fefd4ef887314.tar.gz
cpython-1ecf7d204dd3abb143f53851c31fefd4ef887314.tar.bz2
Issue #28496: Mark up constants 0, 1 and -1 that denote return values or
special input values as literal text.
Diffstat (limited to 'Doc/c-api/capsule.rst')
-rw-r--r--Doc/c-api/capsule.rst10
1 files changed, 5 insertions, 5 deletions
diff --git a/Doc/c-api/capsule.rst b/Doc/c-api/capsule.rst
index 6f6250f..b8642d0 100644
--- a/Doc/c-api/capsule.rst
+++ b/Doc/c-api/capsule.rst
@@ -120,19 +120,19 @@ Refer to :ref:`using-capsules` for more information on using these objects.
guaranteed to succeed.
Return a nonzero value if the object is valid and matches the name passed in.
- Return 0 otherwise. This function will not fail.
+ Return ``0`` otherwise. This function will not fail.
.. c:function:: int PyCapsule_SetContext(PyObject *capsule, void *context)
Set the context pointer inside *capsule* to *context*.
- Return 0 on success. Return nonzero and set an exception on failure.
+ Return ``0`` on success. Return nonzero and set an exception on failure.
.. c:function:: int PyCapsule_SetDestructor(PyObject *capsule, PyCapsule_Destructor destructor)
Set the destructor inside *capsule* to *destructor*.
- Return 0 on success. Return nonzero and set an exception on failure.
+ Return ``0`` on success. Return nonzero and set an exception on failure.
.. c:function:: int PyCapsule_SetName(PyObject *capsule, const char *name)
@@ -140,11 +140,11 @@ Refer to :ref:`using-capsules` for more information on using these objects.
outlive the capsule. If the previous *name* stored in the capsule was not
*NULL*, no attempt is made to free it.
- Return 0 on success. Return nonzero and set an exception on failure.
+ Return ``0`` on success. Return nonzero and set an exception on failure.
.. c:function:: int PyCapsule_SetPointer(PyObject *capsule, void *pointer)
Set the void pointer inside *capsule* to *pointer*. The pointer may not be
*NULL*.
- Return 0 on success. Return nonzero and set an exception on failure.
+ Return ``0`` on success. Return nonzero and set an exception on failure.