summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2020-08-18 19:33:26 -0400
committerNed Batchelder <ned@nedbatchelder.com>2020-08-18 19:33:26 -0400
commit450ac0bf86afb89f800e638ed6b4aed20c678c21 (patch)
treeb3ce194590282dff60e0534ab067bd037a964b5a
parentaa6cb95e366f479cddd8cd30aee940393ead6296 (diff)
downloadpython-coveragepy-git-450ac0bf86afb89f800e638ed6b4aed20c678c21.tar.gz
Prevent trailing whitespace in doc/help/* files
-rw-r--r--Makefile2
-rw-r--r--doc/help/annotate.rst6
-rw-r--r--doc/help/combine.rst6
-rw-r--r--doc/help/debug.rst6
-rw-r--r--doc/help/erase.rst6
-rw-r--r--doc/help/html.rst6
-rw-r--r--doc/help/json.rst6
-rw-r--r--doc/help/report.rst6
-rw-r--r--doc/help/run.rst6
-rw-r--r--doc/help/xml.rst6
10 files changed, 28 insertions, 28 deletions
diff --git a/Makefile b/Makefile
index 780424af..7b383bbc 100644
--- a/Makefile
+++ b/Makefile
@@ -147,7 +147,7 @@ cmd_help: $(DOCBIN)
sed \
-e 's/__main__.py/coverage/' \
-e '/^Full doc/d' \
- -e 's/^/ /' \
+ -e 's/^./ &/' \
>> doc/help/$$cmd.rst; \
done
diff --git a/doc/help/annotate.rst b/doc/help/annotate.rst
index fb80e12e..8f0883a0 100644
--- a/doc/help/annotate.rst
+++ b/doc/help/annotate.rst
@@ -3,10 +3,10 @@
$ coverage annotate --help
Usage: coverage annotate [options] [modules]
-
+
Make annotated copies of the given files, marking statements that are executed
with > and statements that are missed with !.
-
+
Options:
-d DIR, --directory=DIR
Write the output files to DIR.
@@ -23,4 +23,4 @@
--rcfile=RCFILE Specify configuration file. By default '.coveragerc',
'setup.cfg', 'tox.ini', and 'pyproject.toml' are
tried. [env: COVERAGE_RCFILE]
-
+
diff --git a/doc/help/combine.rst b/doc/help/combine.rst
index bf15c23f..35180cdd 100644
--- a/doc/help/combine.rst
+++ b/doc/help/combine.rst
@@ -3,13 +3,13 @@
$ coverage combine --help
Usage: coverage combine [options] <path1> <path2> ... <pathN>
-
+
Combine data from multiple coverage files collected with 'run -p'. The
combined results are written to a single file representing the union of the
data. The positional arguments are data files or directories containing data
files. If no paths are provided, data files in the default data file's
directory are combined.
-
+
Options:
-a, --append Append coverage data to .coverage, otherwise it starts
clean each time.
@@ -18,4 +18,4 @@
--rcfile=RCFILE Specify configuration file. By default '.coveragerc',
'setup.cfg', 'tox.ini', and 'pyproject.toml' are tried.
[env: COVERAGE_RCFILE]
-
+
diff --git a/doc/help/debug.rst b/doc/help/debug.rst
index 7c71e90e..db1e64b2 100644
--- a/doc/help/debug.rst
+++ b/doc/help/debug.rst
@@ -3,16 +3,16 @@
$ coverage debug --help
Usage: coverage debug <topic>
-
+
Display information about the internals of coverage.py, for diagnosing
problems. Topics are: 'data' to show a summary of the collected data; 'sys' to
show installation information; 'config' to show the configuration; 'premain'
to show what is calling coverage.
-
+
Options:
--debug=OPTS Debug options, separated by commas. [env: COVERAGE_DEBUG]
-h, --help Get help on this command.
--rcfile=RCFILE Specify configuration file. By default '.coveragerc',
'setup.cfg', 'tox.ini', and 'pyproject.toml' are tried.
[env: COVERAGE_RCFILE]
-
+
diff --git a/doc/help/erase.rst b/doc/help/erase.rst
index 2bb64800..c8f45155 100644
--- a/doc/help/erase.rst
+++ b/doc/help/erase.rst
@@ -3,13 +3,13 @@
$ coverage erase --help
Usage: coverage erase [options]
-
+
Erase previously collected coverage data.
-
+
Options:
--debug=OPTS Debug options, separated by commas. [env: COVERAGE_DEBUG]
-h, --help Get help on this command.
--rcfile=RCFILE Specify configuration file. By default '.coveragerc',
'setup.cfg', 'tox.ini', and 'pyproject.toml' are tried.
[env: COVERAGE_RCFILE]
-
+
diff --git a/doc/help/html.rst b/doc/help/html.rst
index 5be94711..8dfa285a 100644
--- a/doc/help/html.rst
+++ b/doc/help/html.rst
@@ -3,10 +3,10 @@
$ coverage html --help
Usage: coverage html [options] [modules]
-
+
Create an HTML report of the coverage of the files. Each file gets its own
page, with the source decorated to show executed, excluded, and missed lines.
-
+
Options:
--contexts=REGEX1,REGEX2,...
Only display data from lines covered in the given
@@ -36,4 +36,4 @@
--rcfile=RCFILE Specify configuration file. By default '.coveragerc',
'setup.cfg', 'tox.ini', and 'pyproject.toml' are
tried. [env: COVERAGE_RCFILE]
-
+
diff --git a/doc/help/json.rst b/doc/help/json.rst
index 4028788f..cec488e5 100644
--- a/doc/help/json.rst
+++ b/doc/help/json.rst
@@ -3,9 +3,9 @@
$ coverage json --help
Usage: coverage json [options] [modules]
-
+
Generate a JSON report of coverage results.
-
+
Options:
--contexts=REGEX1,REGEX2,...
Only display data from lines covered in the given
@@ -30,4 +30,4 @@
--rcfile=RCFILE Specify configuration file. By default '.coveragerc',
'setup.cfg', 'tox.ini', and 'pyproject.toml' are
tried. [env: COVERAGE_RCFILE]
-
+
diff --git a/doc/help/report.rst b/doc/help/report.rst
index 97f31777..3408f2bb 100644
--- a/doc/help/report.rst
+++ b/doc/help/report.rst
@@ -3,9 +3,9 @@
$ coverage report --help
Usage: coverage report [options] [modules]
-
+
Report coverage statistics on modules.
-
+
Options:
--contexts=REGEX1,REGEX2,...
Only display data from lines covered in the given
@@ -35,4 +35,4 @@
--rcfile=RCFILE Specify configuration file. By default '.coveragerc',
'setup.cfg', 'tox.ini', and 'pyproject.toml' are
tried. [env: COVERAGE_RCFILE]
-
+
diff --git a/doc/help/run.rst b/doc/help/run.rst
index 07f94aa5..a336929a 100644
--- a/doc/help/run.rst
+++ b/doc/help/run.rst
@@ -3,9 +3,9 @@
$ coverage run --help
Usage: coverage run [options] <pyfile> [program options]
-
+
Run a Python program, measuring code execution.
-
+
Options:
-a, --append Append coverage data to .coverage, otherwise it starts
clean each time.
@@ -39,4 +39,4 @@
--rcfile=RCFILE Specify configuration file. By default '.coveragerc',
'setup.cfg', 'tox.ini', and 'pyproject.toml' are
tried. [env: COVERAGE_RCFILE]
-
+
diff --git a/doc/help/xml.rst b/doc/help/xml.rst
index f83f297b..eb52750d 100644
--- a/doc/help/xml.rst
+++ b/doc/help/xml.rst
@@ -3,9 +3,9 @@
$ coverage xml --help
Usage: coverage xml [options] [modules]
-
+
Generate an XML report of coverage results.
-
+
Options:
--fail-under=MIN Exit with a status of 2 if the total coverage is less
than MIN.
@@ -25,4 +25,4 @@
--rcfile=RCFILE Specify configuration file. By default '.coveragerc',
'setup.cfg', 'tox.ini', and 'pyproject.toml' are
tried. [env: COVERAGE_RCFILE]
-
+