coverage: Warn on missing modules

Signed-off-by: Stephen Finucane <stephen@that.guru>
stephenfin · Oct 6, 2023 · 34c02ff · 34c02ff
1 parent dcc150f
commit 34c02ff
Showing 1 changed file with 11 additions and 3 deletions.
diff --git a/sphinx/ext/coverage.py b/sphinx/ext/coverage.py
@@ -135,14 +135,22 @@ def _determine_py_coverage_modules(
             py_undoc[mod_name] = {'error': err}
             continue
 
-    # if there are additional modules then we warn (but still scan)
-    additional_modules = set(seen_modules) - modules
-    if additional_modules:
+    # if there are additional modules then we warn but continue scanning
+    if additional_modules := set(seen_modules) - modules:
         logger.warning(
             __('the following modules are documented but were not specified '
                'in coverage_modules: %s'),
             ', '.join(additional_modules),
         )
+
+    # likewise, if there are missing modules we warn but continue scanning
+    if additional_modules := modules - set(seen_modules):
+        logger.warning(
+            __('the following modules are specified in coverage_modules '
+               'but were not documented'),
+            ', '.join(additional_modules),
+        )
+
     return sorted(modules)