summaryrefslogtreecommitdiffstats
path: root/Doc/distutils/apiref.rst
diff options
context:
space:
mode:
authorSanchit Khurana <54467174+GeniusLearner@users.noreply.github.com>2019-11-25 22:17:59 (GMT)
committerBrett Cannon <54418+brettcannon@users.noreply.github.com>2019-11-25 22:17:59 (GMT)
commitf8a6316778faff3991144c3aec4fa92d7b30a72b (patch)
tree98cb85c8aba2991605a285d7520ce50be764231c /Doc/distutils/apiref.rst
parentc6a7bdb356835c9d7513b1ea6846683d446fe6c3 (diff)
downloadcpython-f8a6316778faff3991144c3aec4fa92d7b30a72b.zip
cpython-f8a6316778faff3991144c3aec4fa92d7b30a72b.tar.gz
cpython-f8a6316778faff3991144c3aec4fa92d7b30a72b.tar.bz2
bpo-21063: Improve module synopsis for distutils (GH-17363)
Diffstat (limited to 'Doc/distutils/apiref.rst')
-rw-r--r--Doc/distutils/apiref.rst10
1 files changed, 5 insertions, 5 deletions
diff --git a/Doc/distutils/apiref.rst b/Doc/distutils/apiref.rst
index a42d2d3..80136b8 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.