Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add note about PackageMetadata protocol and include link to importlib_metadata docs in usage. #375

Merged
merged 3 commits into from
Mar 20, 2022
Merged

Add note about PackageMetadata protocol and include link to importlib_metadata docs in usage. #375

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2b2676a
Add note about PackageMetadata protocol in the docs.
saaketp Mar 20, 2022
39510a5
Add a See Also: section with link to importlib_metadata docs.
saaketp Mar 20, 2022
5f375a9
Avoid comma splice and use a hyperlink to reference the protocol.
jaraco Mar 20, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/using.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,13 @@ By default, package metadata can live on the file system or in zip archives on
anywhere.


.. seealso::

https://importlib-metadata.readthedocs.io/
The documentation for ``importlib_metadata``, which supplies a
backport of ``importlib.metadata``.


Overview
========

Expand Down Expand Up @@ -162,6 +169,13 @@ all the metadata in a JSON-compatible form per PEP 566::
>>> wheel_metadata.json['requires_python']
'>=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*'

.. note::

The actual type of the object returned by ``metadata()`` is an
implementation detail and should be accessed only through the interface
described by the
`PackageMetadata protocol <https://importlib-metadata.readthedocs.io/en/latest/api.html#importlib_metadata.PackageMetadata>`.


.. _version:

Expand Down