Skip to content

Commit 76ebea3

Browse files
Enforce README example list completeness
Co-authored-by: Shri Sukhani <shrisukhani@users.noreply.github.com>
1 parent 0dbe507 commit 76ebea3

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

tests/test_readme_examples_listing.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,13 @@ def test_readme_example_list_references_existing_example_files():
1313
assert listed_examples != []
1414
for example_path in listed_examples:
1515
assert Path(example_path).is_file()
16+
17+
18+
def test_readme_example_list_covers_all_python_example_scripts():
19+
readme_text = Path("README.md").read_text(encoding="utf-8")
20+
listed_examples = set(re.findall(r"- `([^`]*examples/[^`]*)`", readme_text))
21+
example_files = {
22+
path.as_posix() for path in sorted(Path("examples").glob("*.py"))
23+
}
24+
25+
assert example_files == listed_examples

0 commit comments

Comments
 (0)