classification
Title: `contextvars` documentation incorrectly refers to "non-local state".
Type: enhancement Stage: resolved
Components: asyncio, Documentation Versions: Python 3.8, Python 3.7
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: asvetlov, docs@python, tomchristie, yselivanov
Priority: normal Keywords: patch

Created on 2018-04-26 12:47 by tomchristie, last changed 2018-04-27 22:36 by miss-islington. This issue is now closed.

Pull Requests
URL Status Linked Edit
PR 6617 merged python-dev, 2018-04-27 09:54
PR 6621 merged miss-islington, 2018-04-27 22:36
Messages (4)
msg315792 - (view) Author: Tom Christie (tomchristie) * Date: 2018-04-26 12:47
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.)
msg315803 - (view) Author: Yury Selivanov (yselivanov) * (Python committer) Date: 2018-04-26 15:24
I like what you propose. Can you submit a PR? :)
msg315831 - (view) Author: Tom Christie (tomchristie) * Date: 2018-04-27 09:58
Refs: https://github.com/python/cpython/pull/6617
msg315861 - (view) Author: Yury Selivanov (yselivanov) * (Python committer) Date: 2018-04-27 22:35
Thank you, Tom!
History
Date User Action Args
2018-04-27 22:36:35miss-islingtonsetpull_requests: + pull_request6317
2018-04-27 22:35:45yselivanovsetstatus: open -> closed
resolution: fixed
messages: + msg315861

stage: patch review -> resolved
2018-04-27 09:58:01tomchristiesetmessages: + msg315831
2018-04-27 09:54:07python-devsetkeywords: + patch
stage: patch review
pull_requests: + pull_request6313
2018-04-26 15:24:20yselivanovsetmessages: + msg315803
2018-04-26 12:47:52tomchristiecreate