Skip to content

Commit 089387e

Browse files
bpo-21063: Improve module synopsis for distutils (GH-17363)
(cherry picked from commit f8a6316) Co-authored-by: Sanchit Khurana <[email protected]>
1 parent b9e5547 commit 089387e

File tree

5 files changed

+9
-9
lines changed

5 files changed

+9
-9
lines changed

Doc/distutils/apiref.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1545,7 +1545,7 @@ Python's own build procedures.
15451545
=================================================
15461546

15471547
.. module:: distutils.text_file
1548-
:synopsis: provides the TextFile class, a simple interface to text files
1548+
:synopsis: Provides the TextFile class, a simple interface to text files
15491549

15501550

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

16861686
.. module:: distutils.version
1687-
:synopsis: implements classes that represent module version numbers.
1687+
:synopsis: Implements classes that represent module version numbers.
16881688

16891689

16901690
.. % todo
@@ -1699,7 +1699,7 @@ lines, and joining lines with backslashes.
16991699
===================================================================
17001700

17011701
.. module:: distutils.cmd
1702-
:synopsis: This module provides the abstract base class Command. This class
1702+
:synopsis: Provides the abstract base class :class:`~distutils.cmd.Command`. This class
17031703
is subclassed by the modules in the distutils.command subpackage.
17041704

17051705

@@ -1792,7 +1792,7 @@ Subclasses of :class:`Command` must define the following methods.
17921792
==========================================================
17931793

17941794
.. module:: distutils.command
1795-
:synopsis: This subpackage contains one module for each standard Distutils command.
1795+
:synopsis: Contains one module for each standard Distutils command.
17961796

17971797

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

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

20442044

20452045
The ``check`` command performs some tests on the meta-data of a package.

Doc/library/2to3.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -456,7 +456,7 @@ and off individually. They are described here in more detail.
456456
-------------------------------
457457

458458
.. module:: lib2to3
459-
:synopsis: the 2to3 library
459+
:synopsis: The 2to3 library
460460

461461
.. moduleauthor:: Guido van Rossum
462462
.. moduleauthor:: Collin Winter

Doc/library/linecache.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
================================================
33

44
.. module:: linecache
5-
:synopsis: This module provides random access to individual lines from text files.
5+
:synopsis: Provides random access to individual lines from text files.
66

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

Doc/library/statistics.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
=======================================================
33

44
.. module:: statistics
5-
:synopsis: mathematical statistics functions
5+
:synopsis: Mathematical statistics functions
66

77
.. moduleauthor:: Steven D'Aprano <[email protected]>
88
.. sectionauthor:: Steven D'Aprano <[email protected]>

Doc/library/zipimport.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
=====================================================
33

44
.. module:: zipimport
5-
:synopsis: support for importing Python modules from ZIP archives.
5+
:synopsis: Support for importing Python modules from ZIP archives.
66

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

0 commit comments

Comments
 (0)