[New-bugs-announce] [issue45792] contextvars.Token has wrong module name in Sphinx's objects.inv

Hynek Schlawack report at bugs.python.org
Fri Nov 12 02:59:35 EST 2021


New submission from Hynek Schlawack <hs at ox.cx>:

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.

----------
assignee: hynek
components: Documentation
messages: 406192
nosy: hynek, yselivanov
priority: low
severity: normal
stage: needs patch
status: open
title: contextvars.Token has wrong module name in Sphinx's objects.inv
type: enhancement
versions: Python 3.10, Python 3.11, Python 3.7, Python 3.8, Python 3.9

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


More information about the New-bugs-announce mailing list