Skip to content

Commit ac7d7d9

Browse files
committed
Clarify report() arguments
1 parent f12fcc5 commit ac7d7d9

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

coverage/control.py

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -695,16 +695,26 @@ def report(
695695
file=None, # pylint: disable=redefined-builtin
696696
omit=None, include=None, skip_covered=None,
697697
):
698-
"""Write a summary report to `file`.
698+
"""Write a textual summary report to `file`.
699699
700700
Each module in `morfs` is listed, with counts of statements, executed
701701
statements, missing statements, and a list of lines missed.
702702
703+
If `show_missing` is true, then details of which lines or branches are
704+
missing will be included in the report. If `ignore_errors` is true,
705+
then a failure while reporting a single file will not stop the entire
706+
report.
707+
708+
`file` is a file-like object, suitable for writing.
709+
703710
`include` is a list of file name patterns. Files that match will be
704711
included in the report. Files matching `omit` will not be included in
705712
the report.
706713
707-
If `skip_covered` is True, don't report on files with 100% coverage.
714+
If `skip_covered` is true, don't report on files with 100% coverage.
715+
716+
All of the arguments default to the settings read from the
717+
:ref:`configuration file <config>`.
708718
709719
Returns a float, the total percentage covered.
710720

0 commit comments

Comments
 (0)