diff options
| author | Georg Brandl <georg@python.org> | 2021-12-12 09:49:50 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-12-12 09:49:50 (GMT) |
| commit | f4095e53ab708d95e019c909d5928502775ba68f (patch) | |
| tree | a5bd29a6f8b22183ccf5d9216224cf1c156ca765 /Doc | |
| parent | f3c16a5e72aaf06bec863fa3a172f3deaa491bc9 (diff) | |
| download | cpython-f4095e53ab708d95e019c909d5928502775ba68f.zip cpython-f4095e53ab708d95e019c909d5928502775ba68f.tar.gz cpython-f4095e53ab708d95e019c909d5928502775ba68f.tar.bz2 | |
bpo-45855: document that `no_block` has no use anymore in PyCapsule_Import (#29665)
Diffstat (limited to 'Doc')
| -rw-r--r-- | Doc/c-api/capsule.rst | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/Doc/c-api/capsule.rst b/Doc/c-api/capsule.rst index 908e926..2c4cfc4 100644 --- a/Doc/c-api/capsule.rst +++ b/Doc/c-api/capsule.rst @@ -103,13 +103,14 @@ Refer to :ref:`using-capsules` for more information on using these objects. Import a pointer to a C object from a capsule attribute in a module. The *name* parameter should specify the full name to the attribute, as in ``module.attribute``. The *name* stored in the capsule must match this - string exactly. If *no_block* is true, import the module without blocking - (using :c:func:`PyImport_ImportModuleNoBlock`). If *no_block* is false, - import the module conventionally (using :c:func:`PyImport_ImportModule`). + string exactly. Return the capsule's internal *pointer* on success. On failure, set an exception and return ``NULL``. + .. versionchanged:: 3.3 + *no_block* has no effect anymore. + .. c:function:: int PyCapsule_IsValid(PyObject *capsule, const char *name) |