summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2021-04-28 15:11:15 (GMT)
committerGitHub <noreply@github.com>2021-04-28 15:11:15 (GMT)
commitfdb11897d7c8f9e6bdf96fcef802f784ef90f726 (patch)
tree15b6b4af25106f31dd07989c70efde650413705d
parentcf9d65c5af7905d9e9945a297dbbf15d3bcace15 (diff)
downloadcpython-fdb11897d7c8f9e6bdf96fcef802f784ef90f726.zip
cpython-fdb11897d7c8f9e6bdf96fcef802f784ef90f726.tar.gz
cpython-fdb11897d7c8f9e6bdf96fcef802f784ef90f726.tar.bz2
bpo-43959: clarify the documentation of the PyContextVar C-API (GH-25671) (GH-25689)
(cherry picked from commit 4c49be766897968e509c41397e0e624c25b1675d)
-rw-r--r--Doc/c-api/contextvars.rst13
-rw-r--r--Misc/NEWS.d/next/Documentation/2021-04-27-22-22-22.bpo-43959.n2261q.rst1
2 files changed, 7 insertions, 7 deletions
diff --git a/Doc/c-api/contextvars.rst b/Doc/c-api/contextvars.rst
index 9c08881..d970f54 100644
--- a/Doc/c-api/contextvars.rst
+++ b/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)
diff --git a/Misc/NEWS.d/next/Documentation/2021-04-27-22-22-22.bpo-43959.n2261q.rst b/Misc/NEWS.d/next/Documentation/2021-04-27-22-22-22.bpo-43959.n2261q.rst
new file mode 100644
index 0000000..ba23ffd
--- /dev/null
+++ b/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.