[issue37741] importlib.metadata docs not showing up in the module index
New submission from Brett Cannon <brett@python.org>: If you look at https://docs.python.org/3.9/py-modindex.html#cap-i you will see that importlib.metadata isn't listed (same goes for the 3.8 docs). Or are you leaving it out due to it being provisional? ---------- assignee: docs@python components: Documentation messages: 348872 nosy: barry, brett.cannon, docs@python, jaraco priority: normal severity: normal status: open title: importlib.metadata docs not showing up in the module index versions: Python 3.8, Python 3.9 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue37741> _______________________________________
Fred L. Drake, Jr. <fdrake@gmail.com> added the comment: Provisional status should not cause a module or other API element to be omitted from the indexes. So long as it's marked provisional where it's described, it should be locatable. ---------- nosy: +fdrake _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue37741> _______________________________________
Barry A. Warsaw <barry@python.org> added the comment: There's an importlib.metadata.rst file which describes how to use the API, but that doesn't appear to be linked from either the main library ToC or the importlib documentation itself. I'll see if I can put together a PR to fix this. ---------- assignee: docs@python -> barry _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue37741> _______________________________________
Karthikeyan Singaravelan <tir.karthi@gmail.com> added the comment: Including a module directive with synopsis as below in importlib.metadata.rst seems to fix this. It would also be good to include a link to source code from the importlib.metadata docs page since it's written in Python. .. module:: importlib.metadata :synopsis: The implementation of the importlib metadata. **Source code:** :source:`Lib/importlib/metadata/__init__.py` ---------- nosy: +xtreak _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue37741> _______________________________________
Barry A. Warsaw <barry@python.org> added the comment: @jaraco - Why is the code in `Lib/importlib/metadata/__init__.py` instead of `Lib/importlib/metadata.py`? Is that to make it easier to port between CPython stdlib and the standalone version? ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue37741> _______________________________________
Jason R. Coombs <jaraco@jaraco.com> added the comment:
Why is the code in `Lib/importlib/metadata/__init__.py`
Mainly because originally, the code was in multiple modules. I'm happy for it to move into a single file module. ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue37741> _______________________________________
Brett Cannon <brett@python.org> added the comment: If there's no porting benefit then let's move it to a single module instead of a package. ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue37741> _______________________________________
Barry A. Warsaw <barry@python.org> added the comment: I’ll do a PR for that too.
On Aug 6, 2019, at 14:07, Brett Cannon <report@bugs.python.org> wrote:
Brett Cannon <brett@python.org> added the comment:
If there's no porting benefit then let's move it to a single module instead of a package.
----------
_______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue37741> _______________________________________
---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue37741> _______________________________________
Change by Barry A. Warsaw <barry@python.org>: ---------- keywords: +patch pull_requests: +14887 stage: -> patch review pull_request: https://github.com/python/cpython/pull/15153 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue37741> _______________________________________
Change by miss-islington <mariatta.wijaya+miss-islington@gmail.com>: ---------- pull_requests: +14889 pull_request: https://github.com/python/cpython/pull/15154 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue37741> _______________________________________
Change by Barry A. Warsaw <barry@python.org>: ---------- versions: +Python 3.10 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue37741> _______________________________________
Miro Hrončok <miro@hroncok.cz> added the comment: The docs at https://docs.python.org/3/library/importlib.metadata.html also don't list the API at all, it is just a tutorial, not a reference. I see the code has docstrings, but they are missing from the docs. E.g. PackageNotFoundError is not documented at all. ---------- nosy: +hroncok _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue37741> _______________________________________
Brett Cannon <brett@python.org> added the comment: Are you still planning to fix this, Barry? ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue37741> _______________________________________
Barry A. Warsaw <barry@python.org> added the comment: I'd still like to. I'm also happy to review any PRs if someone beats me to it. ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue37741> _______________________________________
Change by Jason R. Coombs <jaraco@jaraco.com>: ---------- pull_requests: +24147 pull_request: https://github.com/python/cpython/pull/25415 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue37741> _______________________________________
miss-islington <mariatta.wijaya+miss-islington@gmail.com> added the comment: New changeset 23acadcc1c75eb74b2459304af70d97a35001b34 by Jason R. Coombs in branch 'master': bpo-37741: make importlib.metadata docs discoverable through a module directive. (GH-25415) https://github.com/python/cpython/commit/23acadcc1c75eb74b2459304af70d97a350... ---------- nosy: +miss-islington _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue37741> _______________________________________
Change by miss-islington <mariatta.wijaya+miss-islington@gmail.com>: ---------- pull_requests: +24148 pull_request: https://github.com/python/cpython/pull/25417 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue37741> _______________________________________
Change by miss-islington <mariatta.wijaya+miss-islington@gmail.com>: ---------- pull_requests: +24149 pull_request: https://github.com/python/cpython/pull/25418 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue37741> _______________________________________
Barry A. Warsaw <barry@python.org> added the comment: @jaraco beat me to it. PRs approved! ---------- resolution: -> fixed stage: patch review -> resolved status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue37741> _______________________________________
miss-islington <mariatta.wijaya+miss-islington@gmail.com> added the comment: New changeset a746fceb7548e92f58037d9f90b5468bdc76889d by Miss Islington (bot) in branch '3.8': bpo-37741: make importlib.metadata docs discoverable through a module directive. (GH-25415) https://github.com/python/cpython/commit/a746fceb7548e92f58037d9f90b5468bdc7... ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue37741> _______________________________________
participants (7)
-
Barry A. Warsaw -
Brett Cannon
-
Fred L. Drake, Jr.
-
Jason R. Coombs
-
Karthikeyan Singaravelan
-
Miro Hrončok
-
miss-islington