8000 gh-102215: importlib documentation cleanups by yrro · Pull Request #102217 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

gh-102215: importlib documentation cleanups #102217

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

Merged
merged 5 commits into from
May 6, 2023
Merged

gh-102215: importlib documentation cleanups #102217

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c257982
gh-102215: Fix headling level in importlib.resources
yrro Feb 24, 2023
1636c32
importlib.resources: bring section heading format in-line with that o…
yrro Feb 24, 2023
b5cbe0f
importlib.metadata: refer to the module by its importable name
yrro Feb 24, 2023
2bebc2d
importlib.resources: use synopsis in module heading
yrro Feb 24, 2023
8595efc
Refer to the external package as importlib_metadata
yrro May 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions Doc/library/importlib.metadata.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
.. _using:

=================================
Using :mod:`!importlib.metadata`
=================================
========================================================
:mod:`!importlib.metadata` -- Accessing package metadata
========================================================

.. module:: importlib.metadata
:synopsis: The implementation of the importlib metadata.
:synopsis: Accessing package metadata

.. versionadded:: 3.8
.. versionchanged:: 3.10
``importlib.metadata`` is no longer provisional.

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

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

``importlib_metadata`` operates on third-party *distribution packages*
``importlib.metadata`` operates on third-party *distribution packages*
installed into Python's ``site-packages`` directory via tools such as
`pip <https://pypi.org/project/pip/>`_.
Specifically, it works with distributions with discoverable
Expand Down Expand Up @@ -364,7 +364,7 @@ system :ref:`finders <finders-and-loaders>`. To find a distribution package's m
``importlib.metadata`` queries the list of :term:`meta path finders <meta path finder>` on
:data:`sys.meta_path`.

By default ``importlib_metadata`` installs a finder for distribution packages
By default ``importlib.metadata`` installs a finder for distribution packages
found on the file system.
This finder doesn't actually find any *distributions*,
but it can find their metadata.
Expand Down
6 changes: 3 additions & 3 deletions Doc/library/importlib.resources.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:mod:`importlib.resources` -- Resources
---------------------------------------
:mod:`importlib.resources` -- Package resource reading, opening and access
--------------------------------------------------------------------------

.. module:: importlib.resources
:synopsis: Package resource reading, opening, and access
Expand Down Expand Up @@ -97,7 +97,7 @@ for example, a package and its resources can be imported from a zip file using


Deprecated functions
--------------------
^^^^^^^^^^^^^^^^^^^^

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