Skip to content

Commit 2f24893

Browse files
miss-islingtonGeniusLearner
authored andcommitted
bpo-21063: Improve module synopsis for distutils (GH-17363) (#17381)
(cherry picked from commit f8a6316) Co-authored-by: Sanchit Khurana <[email protected]>
1 parent 1f86401 commit 2f24893

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
@@ -1530,7 +1530,7 @@ Python's own build procedures.
15301530
=================================================
15311531

15321532
.. module:: distutils.text_file
1533-
:synopsis: provides the TextFile class, a simple interface to text files
1533+
:synopsis: Provides the TextFile class, a simple interface to text files
15341534

15351535

15361536
This module provides the :class:`TextFile` class, which gives an interface to
@@ -1669,7 +1669,7 @@ lines, and joining lines with backslashes.
16691669
===================================================
16701670

16711671
.. module:: distutils.version
1672-
:synopsis: implements classes that represent module version numbers.
1672+
:synopsis: Implements classes that represent module version numbers.
16731673

16741674

16751675
.. % todo
@@ -1684,7 +1684,7 @@ lines, and joining lines with backslashes.
16841684
===================================================================
16851685

16861686
.. module:: distutils.cmd
1687-
:synopsis: This module provides the abstract base class Command. This class
1687+
:synopsis: Provides the abstract base class :class:`~distutils.cmd.Command`. This class
16881688
is subclassed by the modules in the distutils.command subpackage.
16891689

16901690

@@ -1777,7 +1777,7 @@ Subclasses of :class:`Command` must define the following methods.
17771777
==========================================================
17781778

17791779
.. module:: distutils.command
1780-
:synopsis: This subpackage contains one module for each standard Distutils command.
1780+
:synopsis: Contains one module for each standard Distutils command.
17811781

17821782

17831783
.. % \subsubsection{Individual Distutils commands}
@@ -2021,7 +2021,7 @@ This is described in more detail in :pep:`301`.
20212021
===================================================================
20222022

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

20262026

20272027
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)