8000 gh-102215: importlib documentation cleanups · python/cpython@f0d8897 · GitHub
[go: up one dir, main page]

Skip to content

Commit f0d8897

Browse files
yrromiss-islington
authored andcommitted
gh-102215: importlib documentation cleanups
(cherry picked from commit 4cd95dc) Co-authored-by: Sam Morris <sam@robots.org.uk>
1 parent 6b825c1 commit f0d8897

File tree

2 files changed

+10
-10
lines changed

2 files changed

+10
-10
lines changed

Doc/library/importlib.metadata.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
.. _using:
22

3-
=================================
4-
Using :mod:`!importlib.metadata`
5-
=================================
3+
========================================================
4+
:mod:`!importlib.metadata` -- Accessing package metadata
5+
========================================================
66

77
.. module:: importlib.metadata
8-
:synopsis: The implementation of the importlib metadata.
8+
:synopsis: Accessing package metadata
99

1010
.. versionadded:: 3.8
1111
.. versionchanged:: 3.10
1212
``importlib.metadata`` is no longer provisional.
1313

1414
**Source code:** :source:`Lib/importlib/metadata/__init__.py`
1515

16-
``importlib_metadata`` is a library that provides access to
16+
``importlib.metadata`` is a library that provides access to
1717
the metadata of an installed `Distribution Package <https://packaging.python.org/en/latest/glossary/#term-Distribution-Package>`_,
1818
such as its entry points
1919
or its top-level names (`Import Package <https://packaging.python.org/en/latest/glossary/#term-Import-Package>`_\s, modules, if any).
@@ -24,7 +24,7 @@ API`_ and `metadata API`_ of ``pkg_resources``. Along with
2424
this package can eliminate the need to use the older and less efficient
2525
``pkg_resources`` package.
2626

27-
``importlib_metadata`` operates on third-party *distribution packages*
27+
``importlib.metadata`` operates on third-party *distribution packages*
2828
installed into Python's ``site-packages`` directory via tools such as
2929
`pip <https://pypi.org/project/pip/>`_.
3030
Specifically, it works with distributions with discoverable
@@ -365,7 +365,7 @@ system `finders`_. To find a distribution package's metadata,
365365
``importlib.metadata`` queries the list of :term:`meta path finders <meta path finder>` on
366366
:data:`sys.meta_path`.
367367

368-
By default ``importlib_metadata`` installs a finder for distribution packages
368+
By default ``importlib.metadata`` installs a finder for distribution packages
369369
found on the file system.
370370
This finder doesn't actually find any *distributions*,
371371
but it can find their metadata.

Doc/library/importlib.resources.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
:mod:`importlib.resources` -- Resources
2-
---------------------------------------
1+
:mod:`importlib.resources` -- Package resource reading, opening and access
2+
--------------------------------------------------------------------------
33

44
.. module:: importlib.resources
55
:synopsis: Package resource reading, opening, and access
@@ -79,7 +79,7 @@ for example, a package and its resources can be imported from a zip file using
7979
.. versionadded:: 3.9
8080

8181
Deprecated functions
82-
--------------------
82+
^^^^^^^^^^^^^^^^^^^^
8383

8484
An older, deprecated set of functions is still available, but is
8585
scheduled for removal in a future version of Python.

0 commit comments

Comments
 (0)
0