Skip to content

bpo-21063: Improve module synopsis #17363

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 2 commits into from
Nov 25, 2019
Merged

bpo-21063: Improve module synopsis #17363

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f8165e2
bpo-21063: Improve module synopsis
GeniusLearner Nov 23, 2019
2976f2a
Update Doc/distutils/apiref.rst
GeniusLearner Nov 25, 2019
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
10 changes: 5 additions & 5 deletions Doc/distutils/apiref.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1545,7 +1545,7 @@ Python's own build procedures.
=================================================

.. module:: distutils.text_file
:synopsis: provides the TextFile class, a simple interface to text files
:synopsis: Provides the TextFile class, a simple interface to text files


This module provides the :class:`TextFile` class, which gives an interface to
Expand Down Expand Up @@ -1684,7 +1684,7 @@ lines, and joining lines with backslashes.
===================================================

.. module:: distutils.version
:synopsis: implements classes that represent module version numbers.
:synopsis: Implements classes that represent module version numbers.


.. % todo
Expand All @@ -1699,7 +1699,7 @@ lines, and joining lines with backslashes.
===================================================================

.. module:: distutils.cmd
:synopsis: This module provides the abstract base class Command. This class
:synopsis: Provides the abstract base class :class:`~distutils.cmd.Command`. This class
is subclassed by the modules in the distutils.command subpackage.


Expand Down Expand Up @@ -1792,7 +1792,7 @@ Subclasses of :class:`Command` must define the following methods.
==========================================================

.. module:: distutils.command
:synopsis: This subpackage contains one module for each standard Distutils command.
:synopsis: Contains one module for each standard Distutils command.


.. % \subsubsection{Individual Distutils commands}
Expand Down Expand Up @@ -2039,7 +2039,7 @@ This is described in more detail in :pep:`301`.
===================================================================

.. module:: distutils.command.check
:synopsis: Check the metadata of a package
:synopsis: Check the meta-data of a package


The ``check`` command performs some tests on the meta-data of a package.
Expand Down
2 changes: 1 addition & 1 deletion Doc/library/2to3.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -456,7 +456,7 @@ and off individually. They are described here in more detail.
-------------------------------

.. module:: lib2to3
:synopsis: the 2to3 library
:synopsis: The 2to3 library

.. moduleauthor:: Guido van Rossum
.. moduleauthor:: Collin Winter
Expand Down
2 changes: 1 addition & 1 deletion Doc/library/linecache.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
================================================

.. module:: linecache
:synopsis: This module provides random access to individual lines from text files.
:synopsis: Provides random access to individual lines from text files.

.. sectionauthor:: Moshe Zadka <[email protected]>

Expand Down
2 changes: 1 addition & 1 deletion Doc/library/statistics.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
=======================================================

.. module:: statistics
:synopsis: mathematical statistics functions
:synopsis: Mathematical statistics functions

.. moduleauthor:: Steven D'Aprano <[email protected]>
.. sectionauthor:: Steven D'Aprano <[email protected]>
Expand Down
2 changes: 1 addition & 1 deletion Doc/library/zipimport.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
=====================================================

.. module:: zipimport
:synopsis: support for importing Python modules from ZIP archives.
:synopsis: Support for importing Python modules from ZIP archives.

.. moduleauthor:: Just van Rossum <[email protected]>

Expand Down