bpo-21063: Improve module synopsis for distutils (GH-17363)

This commit is contained in:
Sanchit Khurana 2019-11-26 03:47:59 +05:30 committed by Brett Cannon
parent c6a7bdb356
commit f8a6316778
5 changed files with 9 additions and 9 deletions

View file

@ -1545,7 +1545,7 @@ Python's own build procedures.
================================================= =================================================
.. module:: distutils.text_file .. 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 This module provides the :class:`TextFile` class, which gives an interface to
@ -1684,7 +1684,7 @@ lines, and joining lines with backslashes.
=================================================== ===================================================
.. module:: distutils.version .. module:: distutils.version
:synopsis: implements classes that represent module version numbers. :synopsis: Implements classes that represent module version numbers.
.. % todo .. % todo
@ -1699,7 +1699,7 @@ lines, and joining lines with backslashes.
=================================================================== ===================================================================
.. module:: distutils.cmd .. 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. is subclassed by the modules in the distutils.command subpackage.
@ -1792,7 +1792,7 @@ Subclasses of :class:`Command` must define the following methods.
========================================================== ==========================================================
.. module:: distutils.command .. 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} .. % \subsubsection{Individual Distutils commands}
@ -2039,7 +2039,7 @@ This is described in more detail in :pep:`301`.
=================================================================== ===================================================================
.. module:: distutils.command.check .. 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. The ``check`` command performs some tests on the meta-data of a package.

View file

@ -456,7 +456,7 @@ and off individually. They are described here in more detail.
------------------------------- -------------------------------
.. module:: lib2to3 .. module:: lib2to3
:synopsis: the 2to3 library :synopsis: The 2to3 library
.. moduleauthor:: Guido van Rossum .. moduleauthor:: Guido van Rossum
.. moduleauthor:: Collin Winter .. moduleauthor:: Collin Winter

View file

@ -2,7 +2,7 @@
================================================ ================================================
.. module:: linecache .. 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 <moshez@zadka.site.co.il> .. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il>

View file

@ -2,7 +2,7 @@
======================================================= =======================================================
.. module:: statistics .. module:: statistics
:synopsis: mathematical statistics functions :synopsis: Mathematical statistics functions
.. moduleauthor:: Steven D'Aprano <steve+python@pearwood.info> .. moduleauthor:: Steven D'Aprano <steve+python@pearwood.info>
.. sectionauthor:: Steven D'Aprano <steve+python@pearwood.info> .. sectionauthor:: Steven D'Aprano <steve+python@pearwood.info>

View file

@ -2,7 +2,7 @@
===================================================== =====================================================
.. module:: zipimport .. module:: zipimport
:synopsis: support for importing Python modules from ZIP archives. :synopsis: Support for importing Python modules from ZIP archives.
.. moduleauthor:: Just van Rossum <just@letterror.com> .. moduleauthor:: Just van Rossum <just@letterror.com>