Skip to content

Commit d474029

Browse files
committed
coverage: Warn on missing modules
Signed-off-by: Stephen Finucane <[email protected]>
1 parent 96bb359 commit d474029

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

sphinx/ext/coverage.py

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -135,14 +135,22 @@ def _determine_py_coverage_modules(
135135
py_undoc[mod_name] = {'error': err}
136136
continue
137137

138-
# if there are additional modules then we warn (but still scan)
139-
additional_modules = set(seen_modules) - modules
140-
if additional_modules:
138+
# if there are additional modules then we warn but continue scanning
139+
if additional_modules := set(seen_modules) - modules:
141140
logger.warning(
142141
__('the following modules are documented but were not specified '
143142
'in coverage_modules: %s'),
144143
', '.join(additional_modules),
145144
)
145+
146+
# likewise, if there are missing modules we warn but continue scanning
147+
if additional_modules := modules - set(seen_modules):
148+
logger.warning(
149+
__('the following modules are specified in coverage_modules '
150+
'but were not documented'),
151+
', '.join(additional_modules),
152+
)
153+
146154
return sorted(modules)
147155

148156

0 commit comments

Comments
 (0)