Browse Source

bpo-43959: clarify the documentation of the PyContextVar C-API (GH-25671)

Automerge-Triggered-By: GH:scoder
pull/25698/head
scoder 5 years ago
committed by GitHub
parent
commit
4c49be7668
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
  1. 13
      Doc/c-api/contextvars.rst
  2. 1
      Misc/NEWS.d/next/Documentation/2021-04-27-22-22-22.bpo-43959.n2261q.rst

13
Doc/c-api/contextvars.rst

@ -107,9 +107,9 @@ Context variable functions:
.. c:function:: PyObject *PyContextVar_New(const char *name, PyObject *def)
Create a new ``ContextVar`` object. The *name* parameter is used
for introspection and debug purposes. The *def* parameter may optionally
specify the default value for the context variable. If an error has
occurred, this function returns ``NULL``.
for introspection and debug purposes. The *def* parameter specifies
a default value for the context variable, or ``NULL`` for no default.
If an error has occurred, this function returns ``NULL``.
.. c:function:: int PyContextVar_Get(PyObject *var, PyObject *default_value, PyObject **value)
@ -124,13 +124,12 @@ Context variable functions:
- the default value of *var*, if not ``NULL``;
- ``NULL``
If the value was found, the function will create a new reference to it.
Except for ``NULL``, the function returns a new reference.
.. c:function:: PyObject *PyContextVar_Set(PyObject *var, PyObject *value)
Set the value of *var* to *value* in the current context. Returns a
pointer to a :c:type:`PyObject` object, or ``NULL`` if an error
has occurred.
Set the value of *var* to *value* in the current context. Returns
a new token object for this change, or ``NULL`` if an error has occurred.
.. c:function:: int PyContextVar_Reset(PyObject *var, PyObject *token)

1
Misc/NEWS.d/next/Documentation/2021-04-27-22-22-22.bpo-43959.n2261q.rst

@ -0,0 +1 @@
The documentation on the PyContextVar C-API was clarified.
Loading…
Cancel
Save