Skip to content

Commit cfb3f50

Browse files
committed
docs: tweak up the quick start about the html report
1 parent 7059cc2 commit cfb3f50

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

doc/index.rst

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ Getting started is easy:
9090

9191
.. tab:: unittest
9292

93-
Change "python" to "coverage run", so this::
93+
Change your python command name to "coverage run", so this::
9494

9595
$ python3 -m unittest discover
9696

@@ -134,20 +134,21 @@ Getting started is easy:
134134
listings detailing missed lines::
135135

136136
$ coverage html
137+
Wrote HTML report to htmlcov/index.html
137138

138139
.. ifconfig:: not prerelease
139140

140-
Then open htmlcov/index.html in your browser, to see a
141-
`report like this`_.
141+
Then open `htmlcov/index.html <htmlreport_>`__ in your browser
142+
to see a `report like this <htmlreport_>`__.
142143

143144
.. ifconfig:: prerelease
144145

145-
Then open htmlcov/index.html in your browser, to see a
146-
`report like this one`_.
146+
Then open `htmlcov/index.html <betahtmlreport_>`__ in your browser
147+
to see a `report like this <betahtmlreport_>`__.
147148

148149

149-
.. _report like this: https://nedbatchelder.com/files/sample_coverage_html/index.html
150-
.. _report like this one: https://nedbatchelder.com/files/sample_coverage_html_beta/index.html
150+
.. _htmlreport: https://nedbatchelder.com/files/sample_coverage_html/index.html
151+
.. _betahtmlreport: https://nedbatchelder.com/files/sample_coverage_html_beta/index.html
151152
.. _nose state: https://github.com/nose-devs/nose/commit/0f40fa995384afad77e191636c89eb7d5b8870ca
152153
.. _include tests: https://nedbatchelder.com/blog/202008/you_should_include_your_tests_in_coverage.html
153154

0 commit comments

Comments
 (0)