File tree Expand file tree Collapse file tree 1 file changed +12
-0
lines changed Expand file tree Collapse file tree 1 file changed +12
-0
lines changed Original file line number Diff line number Diff line change @@ -74,6 +74,12 @@ def coverage(
74
74
platforms: set[str], optional
75
75
The set of platforms to use when computing coverage.
76
76
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.
77
83
"""
78
84
if not platforms :
79
85
platforms = set ().union (* setmap .keys ())
@@ -110,6 +116,12 @@ def average_coverage(
110
116
platforms: set[str], optional
111
117
The set of platforms to use when computing coverage.
112
118
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.
113
125
"""
114
126
if not platforms :
115
127
platforms = set ().union (* setmap .keys ())
You can’t perform that action at this time.
0 commit comments