[New-bugs-announce] [issue43959] Improve documentation of PyContextVar C-API

[Stefan Behnel]

New submission from Stefan Behnel <stefan_ml at behnel.de>:

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.

----------
assignee: docs at python
components: Documentation
messages: 392128
nosy: docs at python, scoder
priority: normal
severity: normal
status: open
title: Improve documentation of PyContextVar C-API
type: enhancement
versions: Python 3.10, Python 3.11, Python 3.8, Python 3.9

_______________________________________
Python tracker <report at bugs.python.org>
<https://bugs.python.org/issue43959>
_______________________________________