Skip to content

Commit af89c17

Browse files
committed
coverage: Sort modules
This prevent the table changing every time we generate the report. Signed-off-by: Stephen Finucane <[email protected]>
1 parent 113ac90 commit af89c17

File tree

1 file changed

+3
-4
lines changed

1 file changed

+3
-4
lines changed

sphinx/ext/coverage.py

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,7 @@ def build_py_coverage(self) -> None:
245245
', '.join(additional_modules),
246246
)
247247

248-
for mod_name in modules:
248+
for mod_name in sorted(modules):
249249
ignore = False
250250
for exp in self.mod_ignorexps:
251251
if exp.match(mod_name):
@@ -344,8 +344,7 @@ def build_py_coverage(self) -> None:
344344

345345
def _write_py_statistics(self, op: TextIO) -> None:
346346
""" Outputs the table of ``op``."""
347-
all_modules = set(self.py_documented.keys()).union(
348-
set(self.py_undocumented.keys()))
347+
all_modules = set(self.py_documented.keys()).union(set(self.py_undocumented.keys()))
349348
all_objects: set[str] = set()
350349
all_documented_objects: set[str] = set()
351350
for module in all_modules:
@@ -355,7 +354,7 @@ def _write_py_statistics(self, op: TextIO) -> None:
355354

356355
# prepare tabular
357356
table = [['Module', 'Coverage', 'Undocumented']]
358-
for module in all_modules:
357+
for module in sorted(all_modules):
359358
module_objects = self.py_documented[module].union(self.py_undocumented[module])
360359
if len(module_objects):
361360
value = 100.0 * len(self.py_documented[module]) / len(module_objects)

0 commit comments

Comments
 (0)