@@ -695,16 +695,26 @@ def report(
695
695
file = None , # pylint: disable=redefined-builtin
696
696
omit = None , include = None , skip_covered = None ,
697
697
):
698
- """Write a summary report to `file`.
698
+ """Write a textual summary report to `file`.
699
699
700
700
Each module in `morfs` is listed, with counts of statements, executed
701
701
statements, missing statements, and a list of lines missed.
702
702
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
+
703
710
`include` is a list of file name patterns. Files that match will be
704
711
included in the report. Files matching `omit` will not be included in
705
712
the report.
706
713
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>`.
708
718
709
719
Returns a float, the total percentage covered.
710
720
0 commit comments