contextvars documentation incorrectly refers to "non-local state".

[tomchristie]

BPO	33366
Nosy	@asvetlov, @tomchristie, @1st1
PRs	bpo-33366: Change wording from "non-local state" to "context-local state". #6617 [3.7] bpo-33366: Change "non-local state" to "content-local state". (GH-6617) #6621

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2018-04-27.22:35:45.046>
created_at = <Date 2018-04-26.12:47:52.352>
labels = ['3.8', 'type-feature', '3.7', 'docs', 'expert-asyncio']
title = '`contextvars` documentation incorrectly refers to "non-local state".'
updated_at = <Date 2018-04-27.22:36:35.971>
user = 'https://github.com/tomchristie'

bugs.python.org fields:

activity = <Date 2018-04-27.22:36:35.971>
actor = 'miss-islington'
assignee = 'docs@python'
closed = True
closed_date = <Date 2018-04-27.22:35:45.046>
closer = 'yselivanov'
components = ['Documentation', 'asyncio']
creation = <Date 2018-04-26.12:47:52.352>
creator = 'tomchristie'
dependencies = []
files = []
hgrepos = []
issue_num = 33366
keywords = ['patch']
message_count = 4.0
messages = ['315792', '315803', '315831', '315861']
nosy_count = 4.0
nosy_names = ['asvetlov', 'tomchristie', 'docs@python', 'yselivanov']
pr_nums = ['6617', '6621']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue33366'
versions = ['Python 3.7', 'Python 3.8']

[tomchristie]

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.)

[1st1]

I like what you propose. Can you submit a PR? :)

[tomchristie]

Refs: #6617

[1st1]

Thank you, Tom!