Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork2.3k
Description
Describe the bug
With the recent support for PEP695, the documentation of module level aliases does not have the docstrings inherited, unlike non-type members, i.e. if we have a structure like
# Top-level packagefrom .utilsimportLattice__all__= ["Lattice"]
# Actual implementation (under `.utils`)typeLattice=Sequence[Sequence[float]]__all__= ["Lattice"]
The documentation is different in the top-level
compared to the actual implementation
There is a greater question here though, should the top-level re-implement the documentation, or have a different type and completely link itself to the real implementation (would prefer the latter personally). Whether or not we would want the aliases to be documented could also be configurable, but we would want to at least be able to document them in one form or another particularly if they are explicitly listed in the__all__
How to Reproduce
See snippet above
Environment Information
sphinx master branch after PEP 695 support.Sphinx extensions
Additional context
Split from#11561 (comment)