Skip to content

Commit 85d104c

Browse files
committed
Consolidate more language between the backport and the canonical usage docs.
1 parent 2279f76 commit 85d104c

File tree

2 files changed

+5
-18
lines changed

2 files changed

+5
-18
lines changed

docs/index.rst

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,6 @@
11
Welcome to |project| documentation!
22
===================================
33

4-
``importlib_metadata`` is a library which provides an API for accessing an
5-
installed package's metadata (see :pep:`566`), such as its entry points or its top-level
6-
name. This functionality intends to replace most uses of ``pkg_resources``
7-
`entry point API`_ and `metadata API`_. Along with :mod:`importlib.resources`
8-
and newer (backported as :doc:`importlib_resources <importlib_resources:index>`),
9-
this package can eliminate the need to use the older and less
10-
efficient ``pkg_resources`` package.
11-
124
``importlib_metadata`` supplies a backport of :mod:`importlib.metadata`,
135
enabling early access to features of future Python versions and making
146
functionality available for older Python versions. Users are encouraged to
@@ -43,7 +35,3 @@ Indices and tables
4335
* :ref:`genindex`
4436
* :ref:`modindex`
4537
* :ref:`search`
46-
47-
48-
.. _`entry point API`: https://setuptools.readthedocs.io/en/latest/pkg_resources.html#entry-points
49-
.. _`metadata API`: https://setuptools.readthedocs.io/en/latest/pkg_resources.html#metadata-api

docs/using.rst

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,13 @@
44
Using :mod:`!importlib_metadata`
55
=================================
66

7-
``importlib_metadata`` is a library that provides for access to installed
8-
package metadata. Built in part on Python's import system, this library
7+
``importlib_metadata`` is a library that provides access to installed
8+
package metadata, such as its entry points or its
9+
top-level name. Built in part on Python's import system, this library
910
intends to replace similar functionality in the `entry point
1011
API`_ and `metadata API`_ of ``pkg_resources``. Along with
11-
:mod:`importlib.resources` (with new features backported to
12-
:doc:`importlib_resources <importlib_resources:index>`),
13-
this package can eliminate the need to use the older
14-
and less efficient
12+
:mod:`importlib.resources`,
13+
this package can eliminate the need to use the older and less efficient
1514
``pkg_resources`` package.
1615

1716
By "installed package" we generally mean a third-party package installed into

0 commit comments

Comments
 (0)