diff options
| author | Ned Batchelder <ned@nedbatchelder.com> | 2015-08-03 19:36:59 -0400 |
|---|---|---|
| committer | Ned Batchelder <ned@nedbatchelder.com> | 2015-08-03 19:36:59 -0400 |
| commit | 10f4e01ba81a1d840e43b5888a4d293e6059e1b9 (patch) | |
| tree | 8ebc6ef53b1791249cb6f890f14b8c9ccfb028a6 /coverage/control.py | |
| parent | 2e049a55fb8e2788dc52f7ab760cdbd7ceb662f9 (diff) | |
| download | python-coveragepy-git-10f4e01ba81a1d840e43b5888a4d293e6059e1b9.tar.gz | |
Fix method references in the docs.
Some needed to be :meth:`.foo`, and some didn't. Turned out it was because of
how the .rst used automodule and autoclass.
Diffstat (limited to 'coverage/control.py')
| -rw-r--r-- | coverage/control.py | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/coverage/control.py b/coverage/control.py index 3141c82a..d74aa888 100644 --- a/coverage/control.py +++ b/coverage/control.py @@ -654,10 +654,10 @@ class Coverage(object): """Start measuring code coverage. Coverage measurement actually occurs in functions called after - :meth:`.start` is invoked. Statements in the same scope as - :meth:`.start` won't be measured. + :meth:`start` is invoked. Statements in the same scope as + :meth:`start` won't be measured. - Once you invoke :meth:`.start`, you must also call :meth:`.stop` + Once you invoke :meth:`start`, you must also call :meth:`stop` eventually, or your process might not shut down cleanly. """ @@ -738,7 +738,7 @@ class Coverage(object): def get_exclude_list(self, which='exclude'): """Return a list of excluded regex patterns. - `which` indicates which list is desired. See :meth:`.exclude` for the + `which` indicates which list is desired. See :meth:`exclude` for the lists that are available, and their meaning. """ @@ -972,7 +972,7 @@ class Coverage(object): marker to indicate the coverage of the line. Covered lines have ">", excluded lines have "-", and missing lines have "!". - See :meth:`.report` for other arguments. + See :meth:`report` for other arguments. """ self.get_data() @@ -996,7 +996,7 @@ class Coverage(object): `title` is a text string (not HTML) to use as the title of the HTML report. - See :meth:`.report` for other arguments. + See :meth:`report` for other arguments. Returns a float, the total percentage covered. @@ -1020,7 +1020,7 @@ class Coverage(object): Each module in `morfs` is included in the report. `outfile` is the path to write the file to, "-" will write to stdout. - See :meth:`.report` for other arguments. + See :meth:`report` for other arguments. Returns a float, the total percentage covered. |