summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2019-11-26 12:02:24 -0800
committerBrett Cannon <54418+brettcannon@users.noreply.github.com>2019-11-26 12:02:24 -0800
commit2f2489310d89f589a091aa09ac1eb973d9a383d8 (patch)
tree62e71b36de9cec5db0caef34ff8d8e16a91497ff
parent1f864016950079a618a916140f3abe6480a8e22d (diff)
downloadcpython-git-2f2489310d89f589a091aa09ac1eb973d9a383d8.tar.gz
bpo-21063: Improve module synopsis for distutils (GH-17363) (#17381)
(cherry picked from commit f8a6316778faff3991144c3aec4fa92d7b30a72b) Co-authored-by: Sanchit Khurana <54467174+GeniusLearner@users.noreply.github.com>
-rw-r--r--Doc/distutils/apiref.rst10
-rw-r--r--Doc/library/2to3.rst2
-rw-r--r--Doc/library/linecache.rst2
-rw-r--r--Doc/library/statistics.rst2
-rw-r--r--Doc/library/zipimport.rst2
5 files changed, 9 insertions, 9 deletions
diff --git a/Doc/distutils/apiref.rst b/Doc/distutils/apiref.rst
index 8efeffb637..5ae84e0416 100644
--- a/Doc/distutils/apiref.rst
+++ b/Doc/distutils/apiref.rst
@@ -1530,7 +1530,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
@@ -1669,7 +1669,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
@@ -1684,7 +1684,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.
@@ -1777,7 +1777,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}
@@ -2021,7 +2021,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.
diff --git a/Doc/library/2to3.rst b/Doc/library/2to3.rst
index fa4b0a9645..c3ff3e607e 100644
--- a/Doc/library/2to3.rst
+++ b/Doc/library/2to3.rst
@@ -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
diff --git a/Doc/library/linecache.rst b/Doc/library/linecache.rst
index 34fcac57c0..8387de436a 100644
--- a/Doc/library/linecache.rst
+++ b/Doc/library/linecache.rst
@@ -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 <moshez@zadka.site.co.il>
diff --git a/Doc/library/statistics.rst b/Doc/library/statistics.rst
index 26bb592b23..081fafd45d 100644
--- a/Doc/library/statistics.rst
+++ b/Doc/library/statistics.rst
@@ -2,7 +2,7 @@
=======================================================
.. module:: statistics
- :synopsis: mathematical statistics functions
+ :synopsis: Mathematical statistics functions
.. moduleauthor:: Steven D'Aprano <steve+python@pearwood.info>
.. sectionauthor:: Steven D'Aprano <steve+python@pearwood.info>
diff --git a/Doc/library/zipimport.rst b/Doc/library/zipimport.rst
index eaae2bb04b..fddbb50bce 100644
--- a/Doc/library/zipimport.rst
+++ b/Doc/library/zipimport.rst
@@ -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 <just@letterror.com>