This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: contextvars.Token has wrong module name in Sphinx's objects.inv
Type: enhancement Stage: resolved
Components: Documentation Versions: Python 3.11, Python 3.10, Python 3.9, Python 3.8, Python 3.7
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: hynek Nosy List: asvetlov, hynek, lukasz.langa, miss-islington, yselivanov
Priority: low Keywords: patch

Created on 2021-11-12 07:59 by hynek, last changed 2022-04-11 14:59 by admin. This issue is now closed.

Pull Requests
URL Status Linked Edit
PR 29533 merged hynek, 2021-11-12 08:11
PR 29535 merged miss-islington, 2021-11-12 09:48
PR 29536 merged miss-islington, 2021-11-12 09:48
PR 29537 merged miss-islington, 2021-11-12 09:48
PR 29538 closed miss-islington, 2021-11-12 09:48
Messages (5)
msg406192 - (view) Author: Hynek Schlawack (hynek) * (Python committer) Date: 2021-11-12 07:59
Doc/library/contextvars.rst defines a module using `.. module:: contextvars` which means that all defined symbols are automatically part of the contextvars module.

The docs added in https://github.com/python/cpython/pull/5685 however explicitly use `.. class:: contextvars.Token` instead of just `.. class:: Token` which means that the recorded intersphinx symbol is `contextvars.contextvars.Token`. I have noticed this because sphinx couldn't find `contextvars.Token` in structlog's docs.

AFAICT, this only affects contextvars.Token.
msg406199 - (view) Author: Andrew Svetlov (asvetlov) * (Python committer) Date: 2021-11-12 09:48
New changeset e501d70b347c5093018d12482c30a7a98aab86d0 by Hynek Schlawack in branch 'main':
bpo-45792: Fix contextvar.Token's intersphinx FQN (GH-29533)
https://github.com/python/cpython/commit/e501d70b347c5093018d12482c30a7a98aab86d0
msg406201 - (view) Author: Andrew Svetlov (asvetlov) * (Python committer) Date: 2021-11-12 10:20
New changeset 628667ac9a634c7a7fa7f681dd2f98ff5841c843 by Miss Islington (bot) in branch '3.10':
bpo-45792: Fix contextvar.Token's intersphinx FQN (GH-29533) (GH-29535)
https://github.com/python/cpython/commit/628667ac9a634c7a7fa7f681dd2f98ff5841c843
msg406202 - (view) Author: Andrew Svetlov (asvetlov) * (Python committer) Date: 2021-11-12 10:20
New changeset 8b6a474071bcc88ec3453e16f079181e551513c3 by Miss Islington (bot) in branch '3.9':
bpo-45792: Fix contextvar.Token's intersphinx FQN (GH-29533) (GH-29536)
https://github.com/python/cpython/commit/8b6a474071bcc88ec3453e16f079181e551513c3
msg406393 - (view) Author: Łukasz Langa (lukasz.langa) * (Python committer) Date: 2021-11-16 09:57
New changeset c37a0d9c0ae4aa0d9135fac9a58afc7b34ff71d6 by Miss Islington (bot) in branch '3.8':
bpo-45792: Fix contextvar.Token's intersphinx FQN (GH-29533) (GH-29537)
https://github.com/python/cpython/commit/c37a0d9c0ae4aa0d9135fac9a58afc7b34ff71d6
History
Date User Action Args
2022-04-11 14:59:52adminsetgithub: 89950
2021-11-16 12:46:05asvetlovsetstatus: open -> closed
resolution: fixed
stage: patch review -> resolved
2021-11-16 09:57:21lukasz.langasetnosy: + lukasz.langa
messages: + msg406393
2021-11-12 10:20:25asvetlovsetmessages: + msg406202
2021-11-12 10:20:08asvetlovsetmessages: + msg406201
2021-11-12 09:48:17miss-islingtonsetpull_requests: + pull_request27788
2021-11-12 09:48:12miss-islingtonsetpull_requests: + pull_request27787
2021-11-12 09:48:08miss-islingtonsetpull_requests: + pull_request27786
2021-11-12 09:48:05asvetlovsetnosy: + asvetlov
messages: + msg406199
2021-11-12 09:48:04miss-islingtonsetnosy: + miss-islington
pull_requests: + pull_request27785
2021-11-12 08:11:20hyneksetkeywords: + patch
stage: needs patch -> patch review
pull_requests: + pull_request27783
2021-11-12 07:59:35hynekcreate