classification
Title: importlib.metadata docs not showing up in the module index
Type: Stage: patch review
Components: Documentation Versions: Python 3.9, Python 3.8
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: barry Nosy List: barry, brett.cannon, docs@python, fdrake, jaraco, xtreak
Priority: normal Keywords: patch

Created on 2019-08-01 18:47 by brett.cannon, last changed 2019-08-07 01:36 by miss-islington.

Pull Requests
URL Status Linked Edit
PR 15153 merged barry, 2019-08-06 22:44
PR 15154 merged miss-islington, 2019-08-07 01:36
Messages (8)
msg348872 - (view) Author: Brett Cannon (brett.cannon) * (Python committer) Date: 2019-08-01 18:47
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?
msg348874 - (view) Author: Fred Drake (fdrake) (Python committer) Date: 2019-08-01 19:51
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.
msg349060 - (view) Author: Barry A. Warsaw (barry) * (Python committer) Date: 2019-08-05 17:25
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.
msg349062 - (view) Author: Karthikeyan Singaravelan (xtreak) * (Python committer) Date: 2019-08-05 18:21
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`
msg349063 - (view) Author: Barry A. Warsaw (barry) * (Python committer) Date: 2019-08-05 18:25
@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?
msg349090 - (view) Author: Jason R. Coombs (jaraco) * (Python committer) Date: 2019-08-05 23:20
> 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.
msg349134 - (view) Author: Brett Cannon (brett.cannon) * (Python committer) Date: 2019-08-06 21:07
If there's no porting benefit then let's move it to a single module instead of a package.
msg349137 - (view) Author: Barry A. Warsaw (barry) * (Python committer) Date: 2019-08-06 22:04
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>
> _______________________________________
History
Date User Action Args
2019-08-07 01:36:03miss-islingtonsetpull_requests: + pull_request14889
2019-08-06 22:44:34barrysetkeywords: + patch
stage: patch review
pull_requests: + pull_request14887
2019-08-06 22:04:22barrysetmessages: + msg349137
2019-08-06 21:07:42brett.cannonsetmessages: + msg349134
2019-08-05 23:20:31jaracosetmessages: + msg349090
2019-08-05 18:25:39barrysetmessages: + msg349063
2019-08-05 18:21:33xtreaksetnosy: + xtreak
messages: + msg349062
2019-08-05 17:25:49barrysetassignee: docs@python -> barry
messages: + msg349060
2019-08-01 19:51:49fdrakesetnosy: + fdrake
messages: + msg348874
2019-08-01 18:47:05brett.cannoncreate