[New-bugs-announce] [issue33366] `contextvars` documentation incorrectly refers to "non-local state".

[Tom Christie]

New submission from Tom Christie <tom at tomchristie.com>:

The `contextvars` documentation, at https://docs.python.org/3.7/library/contextvars.html starts with the following:

"This module provides APIs to manage, store, and access non-local state."

I assume that must be a documentation bug, right. The module isn't for managing non-local state, it's for managing state that *is* local.

I'd assume it ought to read...

"This module provides APIs to manage, store, and access context-local state."

(ie. for managing state that is transparently either thread-local or task-local depending on the current execution context.)

----------
assignee: docs at python
components: Documentation, asyncio
messages: 315792
nosy: asvetlov, docs at python, tomchristie, yselivanov
priority: normal
severity: normal
status: open
title: `contextvars` documentation incorrectly refers to "non-local state".
type: enhancement
versions: Python 3.7, Python 3.8

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