Conversation
…ompleteness - Add _fs_utils.py row to the ### Components table in architecture.md - Add test_components_table_lists_all_modules to test_docs.py that enumerates all src/copilot_usage/*.py modules and asserts each one appears in the Components table Closes #881 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This PR updates the copilot-usage architecture documentation to include the missing _fs_utils.py module and adds a regression test to ensure all src/copilot_usage/*.py modules are listed in the ### Components table going forward.
Changes:
- Added a
_fs_utils.pyentry tosrc/copilot_usage/docs/architecture.mdunder the### Componentstable. - Added
test_components_table_lists_all_modulesintests/test_docs.pyto assert every top-level module file is represented in the Components table.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
tests/test_docs.py |
Adds a docs regression test to enforce completeness of the architecture Components table. |
src/copilot_usage/docs/architecture.md |
Documents _fs_utils.py in the Components table, including its exported symbols and consumers. |
microsasa
added
the
aw-review-response-attempted
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
Commit pushed:
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Low-impact documentation + test-only change. The architecture.md update accurately describes _fs_utils.py (lru_insert, safe_file_identity), and the new test_components_table_lists_all_modules test is well-structured to prevent future modules from being silently omitted. CI green, code quality good. Auto-approving for merge.
microsasa
deleted the
fix/881-fs-utils-architecture-docs-8d3a954f2e76e964
branch
Closes #881
Changes
src/copilot_usage/docs/architecture.md— Added_fs_utils.pyrow to the### Componentstable describing its two public symbols (lru_insert,safe_file_identity) and their consumers.tests/test_docs.py— Addedtest_components_table_lists_all_modulesthat enumerates allsrc/copilot_usage/*.pymodules (excluding__init__.py) and asserts each one appears in the Components table. This prevents future modules from being silently omitted.Testing
_fs_utils.pyis absent from the table) and passes after both changes are applied.make checkpasses cleanly (lint, typecheck, security, unit + e2e tests at 99% coverage).