python / importlib_metadata

Library to access metadata for Python packages
https://importlib-metadata.readthedocs.io
Apache License 2.0
123 stars 80 forks source link

Add note that API docs (and migration guide) can be found on importlib_metadata docs #400

Closed CAM-Gerlach closed 1 year ago

CAM-Gerlach commented 2 years ago

As discussed on the Python Discourse, it could be made clearer in the Using importlib_metadata documentation, and thus its CPython equivalent, that the API documentation (and migration guide) can be found on the importlib_metadata docs site, as many users are not necessarily aware of such.

Ideally, it would be included directly in the CPython docs either via Sphinx-Autodoc, manually or some other mechanism, given the linked version would be out of sync with what is actually included in the particular version of the CPython source, but this is a useful quick stopgap for now.