Remove Scout-specific references - #10
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Essentials Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
Included review availability: 3 reviews are currently available. Your included PR review attempts over the past 7 days set your current allowance at 5 reviews per hour. 📝 WalkthroughWalkthroughThe changes remove Scout-specific terminology from documentation, fixtures, package metadata, and tests. The legacy archive uses generic naming and paths. Test documentation now refers to the source consumer and package context. ChangesLegacy archive generalization
Estimated code review effort: 1 (Trivial) | ~5 minutes Merge Risk: ⚪ Minimal · up to This PR removes Scout-specific references across documentation, tests, and example/archive names. No actionable merge-blocking risk remains after normal checks and review. 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches 💡 1📝 Generate docstrings 💡
🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
🟢 Approval recommended
All consumer-specific references and paths appear consistently updated with only minor docstring wording nits remaining (fixes suggested in comments).
Pull request overview
This PR removes consumer-specific (“Scout”) references across tests, docs, and the paa-contracts artifact set, making the repository wording and fixture paths implementation-neutral while keeping the conformance corpus intact.
Changes:
- Replaces “Scout” references in tests/docs with “source consumer” / neutral phrasing and updates the test actor env var to
PAA_TEST_ACTOR. - Renames the archived capture artifact root from
examples/scout-archivetoexamples/legacy-archiveacrosspaa-contractsand conformance tests. - Updates the pre-cutover capture JSON’s actor fields to remove Scout-specific naming.
File summaries
| File | Description |
|---|---|
| tests/test_service.py | Updates porting references and test env var name; minor docstring text adjustments. |
| tests/test_declarations.py | Updates module documentation to remove Scout-specific references. |
| README.md | Updates project README wording about the pre-cutover capture’s origin. |
| packages/paa-contracts/tests/test_contracts.py | Updates expected required artifact roots to examples/legacy-archive. |
| packages/paa-contracts/src/paa_contracts/init.py | Updates required artifact roots to reference examples/legacy-archive. |
| packages/paa-contracts/scripts/verify_built_wheel.py | Keeps wheel verification in sync with the renamed artifact directory. |
| packages/paa-contracts/README.md | Makes consumer references implementation-neutral in the dependency diagram. |
| packages/paa-contracts/hatch_build.py | Updates build hook artifact list to include examples/legacy-archive. |
| PAA.md | Updates spec-mapping narrative to remove Scout-specific references and point to legacy-archive. |
| examples/refund_quickstart/README.md | Removes Scout-specific wording in example documentation. |
| examples/legacy-archive/pre-cutover-capture.json | Removes Scout-specific actor naming in the archived capture data. |
| conformance/test_legacy_archive.py | Updates conformance test name/path to use legacy-archive and neutral phrasing. |
Review details
Suppressed comments (1)
tests/test_service.py:9
- The module docstring breaks the
tests/test_declarations.pyfilename across a line break (tests/test_declarations.thenpy's), which reads like a sentence break rather than a path and is easy to misread.
Ported from the source consumer's service tests. Its in_memory_state
fixture, its module-global PRODUCER_REGISTRY, and its checked-in
contracts/paa declarations directory don't exist here — this package
ships no conftest, so a real SqliteEventStore against a tmp_path database
plus small local declaration fixtures (mirroring tests/test_declarations.
- Files reviewed: 12/12 changed files
- Comments generated: 1
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| """A RuntimeConfig pointed at a one-task declarations directory cloned | ||
| from _OUTBOUND_TASK with version/initial_position overridden — mirrors | ||
| Scout's _write_versioned_declaration technique for isolating a | ||
| The source suite's versioned-declaration technique for isolating a | ||
| declaration-version bump in a test.""" |
|
Addressed the latest review round in daa957f:
Validation: |
Summary by CodeRabbit
Documentation
Tests