Skip to content

Commit 29fc127

Browse files
committed
Add missing Returns section to coverage docstrings
Signed-off-by: John Pennycook <john.pennycook@intel.com>
1 parent e45edc6 commit 29fc127

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

codebasin/report.py

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,12 @@ def coverage(
7474
platforms: set[str], optional
7575
The set of platforms to use when computing coverage.
7676
If not provided, computes coverage for all platforms.
77+
78+
Returns
79+
-------
80+
float
81+
The amount of code used by at least one platform, as a percentage.
82+
If `setmap` contains no lines of code or no platforms, returns NaN.
7783
"""
7884
if not platforms:
7985
platforms = set().union(*setmap.keys())
@@ -110,6 +116,12 @@ def average_coverage(
110116
platforms: set[str], optional
111117
The set of platforms to use when computing coverage.
112118
If not provided, computes average over all platforms.
119+
120+
Returns
121+
-------
122+
float
123+
The average amount of code used by each platform, as a percentage.
124+
If `setmap` contains no lines of code or no platforms, returns NaN.
113125
"""
114126
if not platforms:
115127
platforms = set().union(*setmap.keys())

0 commit comments

Comments
 (0)