classification
Title: Improve documentation of PyContextVar C-API
Type: enhancement Stage: resolved
Components: Documentation Versions: Python 3.11, Python 3.10, Python 3.9, Python 3.8
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, miss-islington, scoder
Priority: normal Keywords: patch

Created on 2021-04-27 20:13 by scoder, last changed 2021-04-28 15:18 by scoder. This issue is now closed.

Pull Requests
URL Status Linked Edit
PR 25671 merged scoder, 2021-04-27 20:20
PR 25689 merged miss-islington, 2021-04-28 14:03
PR 25690 merged miss-islington, 2021-04-28 14:03
Messages (4)
msg392128 - (view) Author: Stefan Behnel (scoder) * (Python committer) Date: 2021-04-27 20:13
The documentation of the PyContextVar C-API is unclear in a couple of places.

- It's not clear whether PyContextVar_Get() always returns an owned reference also for default values or only if a value was found.
- It's not explicit that "optional" actually means "pass an object reference or NULL".
- The return value of PyContextVar_Set() is not explained.
msg392202 - (view) Author: miss-islington (miss-islington) Date: 2021-04-28 14:03
New changeset 4c49be766897968e509c41397e0e624c25b1675d by scoder in branch 'master':
bpo-43959: clarify the documentation of the PyContextVar C-API (GH-25671)
https://github.com/python/cpython/commit/4c49be766897968e509c41397e0e624c25b1675d
msg392210 - (view) Author: Stefan Behnel (scoder) * (Python committer) Date: 2021-04-28 15:11
New changeset fdb11897d7c8f9e6bdf96fcef802f784ef90f726 by Miss Islington (bot) in branch '3.9':
bpo-43959: clarify the documentation of the PyContextVar C-API (GH-25671) (GH-25689)
https://github.com/python/cpython/commit/fdb11897d7c8f9e6bdf96fcef802f784ef90f726
msg392211 - (view) Author: Stefan Behnel (scoder) * (Python committer) Date: 2021-04-28 15:11
New changeset ff7266efd0ef6b42dad30c9c0d210f843cc44f39 by Miss Islington (bot) in branch '3.8':
bpo-43959: clarify the documentation of the PyContextVar C-API (GH-25671) (GH-25690)
https://github.com/python/cpython/commit/ff7266efd0ef6b42dad30c9c0d210f843cc44f39
History
Date User Action Args
2021-04-28 15:18:17scodersetstatus: open -> closed
resolution: fixed
stage: patch review -> resolved
2021-04-28 15:11:56scodersetmessages: + msg392211
2021-04-28 15:11:22scodersetmessages: + msg392210
2021-04-28 14:03:37miss-islingtonsetpull_requests: + pull_request24380
2021-04-28 14:03:31miss-islingtonsetpull_requests: + pull_request24379
2021-04-28 14:03:26miss-islingtonsetnosy: + miss-islington
messages: + msg392202
2021-04-27 20:20:21scodersetkeywords: + patch
stage: patch review
pull_requests: + pull_request24362
2021-04-27 20:13:25scodercreate