Skip to content

Commit 2b2676a

Browse files
committed
Add note about PackageMetadata protocol in the docs.
1 parent 4212eed commit 2b2676a

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

docs/using.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,12 @@ all the metadata in a JSON-compatible form per PEP 566::
162162
>>> wheel_metadata.json['requires_python']
163163
'>=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*'
164164

165+
.. note::
166+
167+
The actual type of the object returned by ``metadata()`` is an
168+
implementation detail, it should be accessed only through the interface
169+
described by the ``PackageMetadata`` protocol documented here and at
170+
https://importlib-metadata.readthedocs.io/en/latest/api.html#importlib_metadata.PackageMetadata
165171

166172
.. _version:
167173

0 commit comments

Comments
 (0)