Skip to content

Commit bd26c49

Browse files
committed
misc: Style and docs changes
* Fix check sum and description in cmd.rst file to pass the auto checks * Add types for parameters in do_dump Signed-off-by: Arkady Gilinsky <[email protected]>
1 parent 761ece5 commit bd26c49

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

coverage/cmdline.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
import sys
1515
import textwrap
1616
import traceback
17+
import types
1718

1819
from typing import cast, Any, NoReturn
1920

@@ -818,7 +819,7 @@ def do_help(
818819

819820
return False
820821

821-
def do_dump(self, signum, frame):
822+
def do_dump(self, signum: int, frame: types.FrameType | None) -> None:
822823
print("Dumping coverage data ...")
823824
self.coverage.save()
824825

doc/cmd.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -139,15 +139,16 @@ There are many options:
139139
--timid Use the slower Python trace function core.
140140
--dump_signal=DUMP_SIGNAL
141141
Define a system signal that will trigger coverage
142-
report dump. Currently supported options are: USR1,
143-
USR2.
142+
report dump. It is important that target script do not
143+
intercept this signal. Currently supported options
144+
are: USR1, USR2.
144145
--debug=OPTS Debug options, separated by commas. [env:
145146
COVERAGE_DEBUG]
146147
-h, --help Get help on this command.
147148
--rcfile=RCFILE Specify configuration file. By default '.coveragerc',
148149
'setup.cfg', 'tox.ini', and 'pyproject.toml' are
149150
tried. [env: COVERAGE_RCFILE]
150-
.. [[[end]]] (sum: saD//ido/B)
151+
.. [[[end]]] (sum: kxkJi2xQZv)
151152
152153
If you want :ref:`branch coverage <branch>` measurement, use the ``--branch``
153154
flag. Otherwise only statement coverage is measured.

0 commit comments

Comments
 (0)