[Python-checkins] bpo-21063: Improve module synopsis for distutils (GH-17363)
Miss Islington (bot)
webhook-mailer at python.org
Mon Nov 25 17:26:47 EST 2019
https://github.com/python/cpython/commit/089387ed1f47d9443b5f28bb1863294eeac2de08
commit: 089387ed1f47d9443b5f28bb1863294eeac2de08
branch: 3.8
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: GitHub <noreply at github.com>
date: 2019-11-25T14:26:43-08:00
summary:
bpo-21063: Improve module synopsis for distutils (GH-17363)
(cherry picked from commit f8a6316778faff3991144c3aec4fa92d7b30a72b)
Co-authored-by: Sanchit Khurana <54467174+GeniusLearner at users.noreply.github.com>
files:
M Doc/distutils/apiref.rst
M Doc/library/2to3.rst
M Doc/library/linecache.rst
M Doc/library/statistics.rst
M Doc/library/zipimport.rst
diff --git a/Doc/distutils/apiref.rst b/Doc/distutils/apiref.rst
index a42d2d3559f2b..80136b8a6bcdd 100644
--- a/Doc/distutils/apiref.rst
+++ b/Doc/distutils/apiref.rst
@@ -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
@@ -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
@@ -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.
@@ -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}
@@ -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.
diff --git a/Doc/library/2to3.rst b/Doc/library/2to3.rst
index fa4b0a9645531..c3ff3e607e797 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 9278fc0641fca..dd9f4ee45ba82 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 at zadka.site.co.il>
diff --git a/Doc/library/statistics.rst b/Doc/library/statistics.rst
index a790ed81a5607..4c7239c1895fb 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 at pearwood.info>
.. sectionauthor:: Steven D'Aprano <steve+python at pearwood.info>
diff --git a/Doc/library/zipimport.rst b/Doc/library/zipimport.rst
index 2138697ff0641..8ac3fb16bdb90 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 at letterror.com>
More information about the Python-checkins
mailing list