Skip to content

Commit

Permalink
gh-101100: Fix Sphinx warnings in library/pydoc.rst (#116913)
Browse files Browse the repository at this point in the history
  • Loading branch information
hugovk committed Mar 19, 2024
1 parent 1ab0d0b commit 9080e9e
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 8 deletions.
14 changes: 7 additions & 7 deletions Doc/library/pydoc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,19 +16,19 @@

--------------

The :mod:`pydoc` module automatically generates documentation from Python
The :mod:`!pydoc` module automatically generates documentation from Python
modules. The documentation can be presented as pages of text on the console,
served to a web browser, or saved to HTML files.

For modules, classes, functions and methods, the displayed documentation is
derived from the docstring (i.e. the :attr:`__doc__` attribute) of the object,
derived from the docstring (i.e. the :attr:`!__doc__` attribute) of the object,
and recursively of its documentable members. If there is no docstring,
:mod:`pydoc` tries to obtain a description from the block of comment lines just
:mod:`!pydoc` tries to obtain a description from the block of comment lines just
above the definition of the class, function or method in the source file, or at
the top of the module (see :func:`inspect.getcomments`).

The built-in function :func:`help` invokes the online help system in the
interactive interpreter, which uses :mod:`pydoc` to generate its documentation
interactive interpreter, which uses :mod:`!pydoc` to generate its documentation
as text on the console. The same text documentation can also be viewed from
outside the Python interpreter by running :program:`pydoc` as a script at the
operating system's command prompt. For example, running ::
Expand All @@ -46,7 +46,7 @@ produced for that file.

.. note::

In order to find objects and their documentation, :mod:`pydoc` imports the
In order to find objects and their documentation, :mod:`!pydoc` imports the
module(s) to be documented. Therefore, any code on module level will be
executed on that occasion. Use an ``if __name__ == '__main__':`` guard to
only execute code when a file is invoked as a script and not just imported.
Expand Down Expand Up @@ -90,7 +90,7 @@ Python interpreter and typed ``import spam``.
Module docs for core modules are assumed to reside in
``https://docs.python.org/X.Y/library/`` where ``X`` and ``Y`` are the
major and minor version numbers of the Python interpreter. This can
be overridden by setting the :envvar:`PYTHONDOCS` environment variable
be overridden by setting the :envvar:`!PYTHONDOCS` environment variable
to a different URL or to a local directory containing the Library
Reference Manual pages.

Expand All @@ -101,7 +101,7 @@ Reference Manual pages.
The ``-g`` command line option was removed.

.. versionchanged:: 3.4
:mod:`pydoc` now uses :func:`inspect.signature` rather than
:mod:`!pydoc` now uses :func:`inspect.signature` rather than
:func:`inspect.getfullargspec` to extract signature information from
callables.

Expand Down
1 change: 0 additions & 1 deletion Doc/tools/.nitignore
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,6 @@ Doc/library/pickletools.rst
Doc/library/platform.rst
Doc/library/plistlib.rst
Doc/library/profile.rst
Doc/library/pydoc.rst
Doc/library/pyexpat.rst
Doc/library/readline.rst
Doc/library/resource.rst
Expand Down

0 comments on commit 9080e9e

Please sign in to comment.