Skip to content

Commit e45edc6

Browse files
committed
Clarify average_coverage docstring
Signed-off-by: John Pennycook <john.pennycook@intel.com>
1 parent 89144ea commit e45edc6

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

codebasin/report.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,8 +98,9 @@ def average_coverage(
9898
platforms: set[str] | None = None,
9999
) -> float:
100100
"""
101-
Compute the average percentage of lines in `setmap` required by each
102-
platform in the supplied `platforms` set.
101+
Computes the coverage for each platform in the supplied `platforms` set
102+
(by calling :py:func:`coverage` for each platform), then returns the
103+
average (mean) of these values.
103104
104105
Parameters
105106
----------

0 commit comments

Comments
 (0)