Skip to content

Commit cc02c13

Browse files
Enforce sorted README example inventory
Co-authored-by: Shri Sukhani <shrisukhani@users.noreply.github.com>
1 parent c191147 commit cc02c13

2 files changed

Lines changed: 15 additions & 8 deletions

File tree

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -257,18 +257,18 @@ Contributor workflow details are available in [CONTRIBUTING.md](CONTRIBUTING.md)
257257

258258
Ready-to-run examples are available in `examples/`:
259259

260-
- `examples/sync_scrape.py`
261-
- `examples/async_scrape.py`
262-
- `examples/async_extract.py`
263-
- `examples/sync_extract.py`
264-
- `examples/sync_crawl.py`
265260
- `examples/async_crawl.py`
266-
- `examples/sync_web_fetch.py`
261+
- `examples/async_extract.py`
262+
- `examples/async_scrape.py`
263+
- `examples/async_session_list.py`
267264
- `examples/async_web_fetch.py`
268-
- `examples/sync_web_search.py`
269265
- `examples/async_web_search.py`
266+
- `examples/sync_crawl.py`
267+
- `examples/sync_extract.py`
268+
- `examples/sync_scrape.py`
270269
- `examples/sync_session_list.py`
271-
- `examples/async_session_list.py`
270+
- `examples/sync_web_fetch.py`
271+
- `examples/sync_web_search.py`
272272

273273
## License
274274

tests/test_readme_examples_listing.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,10 @@ def test_readme_example_list_covers_all_python_example_scripts():
2323
}
2424

2525
assert example_files == listed_examples
26+
27+
28+
def test_readme_example_list_is_sorted():
29+
readme_text = Path("README.md").read_text(encoding="utf-8")
30+
listed_examples = re.findall(r"- `([^`]*examples/[^`]*)`", readme_text)
31+
32+
assert listed_examples == sorted(listed_examples)

0 commit comments

Comments
 (0)