Skip to content

Commit 1d0f0bb

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

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
@@ -136,14 +136,22 @@ def _determine_py_coverage_modules(
136136
py_undoc[mod_name] = {'error': err}
137137
continue
138138

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

149157

0 commit comments

Comments
 (0)