Mention API ref & migration guide in importlib_metadata See Also #401
Conversation
| This includes an `API reference | ||
| <https://importlib-metadata.readthedocs.io/en/latest/api.html>`__ | ||
| for this module's classes and functions, | ||
| as well as a `migration guide | ||
| <https://importlib-metadata.readthedocs.io/en/latest/migration.html>`__ | ||
| for existing users of ``pkg_resources``. |
There was a problem hiding this comment.
I'm a little concerned about adding multiple references and keeping those in sync. Why not just "..., which supplies a backport of importlib.metadata and includes an API reference and migration guide for users of pkg_resources." That would inform the users of the presence of those aspects without keeping them linked.
There was a problem hiding this comment.
That's a good point. We could use :ref: via Intersphinx which would keep them in sync automatically, though that would require adding intersphinx to the CPython docs build config which I'm not sure the downstreams would like (since it requires either network access or a local cache when building docs). But if you think so, we can just go with it for now—you're the maintainer, of course.
|
On further consideration, let's try the links. If they become onerous to maintain, we may replace them later with a less specific reference. |
Per #400 and as As discussed on the Python Discourse, this clarifies the Using importlib_metadata documentation (and thus its CPython equivalent) that the API documentation (and migration guide) for the latest version of
importlib.metadata` can be found on theimportlib_metadata`` docs site.Fix #400