chore(debt): stale package READMEs → CIC signposts; de-WandB config/README text - #228
Merged
Conversation
…README text (tech-debt round) /tech-debt-cleanup round, investigation-first. The safe set: - visualizations/README.md + mapping/README.md: extraction-era relics (one still titled "VIEWS Pipeline Core"!) carrying 300 lines of CMDataset-era API docs SHIPPED IN THE WHEEL - replaced with slim, current overviews that defer to the CICs as the single contract source (parallel API docs are the C-210 drift class; these two package READMEs were outside the documentation/ audit scope and had rotted furthest). - reports/README.md: WandB example config + integration-table row replaced with current equivalents (EvaluationSource/MetricFrame). - config/_reporting.py: canonical-metrics comment no longer claims tokens must match "the WandB run summary" (MetricFrame via the injected source since C-108/B2). Withdrawn during investigation: deleting reports/utils.find_item_names as dead code - it is ALIVE (called intra-file by search_for_item_name at utils.py:118; the initial use-site grep excluded the defining file). Investigation-before-cleanup working as intended. Deferred (documented, no register entries - all Tier-4 observations): sys.path.insert test idiom (import-mechanics churn > value); dataset_statistics.py module-name misnomer (rename churn; C-185 umbrella); mapping.py/report.py module size (critical-path split risk > benefit); the twin 1-row/N-row frame helpers (legitimate specialization, not dup). No behavior changes; no memory/runtime impact (docs + comments only). ruff clean; 362 passed / 2 skipped / 1 xfailed. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
…row (pipeline-core-era numbering ghost) and the retired ln_ target example
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
/tech-debt-cleanup round — the safe set only
Investigation summary
Seeded from the fresh repo-assimilation + docs audit. Full debt map produced; changes restricted to zero-behaviour text/docs per the skill's stability constraint.
Cleanups performed
visualizations/README.md(296 lines, still titled "VIEWS Pipeline Core", CMDataset-era API docs — shipped in the wheel!) andmapping/README.mdreplaced with slim current overviews deferring to the CICs. Parallel API docs are the C-210 drift class; these two sat outside thedocumentation/audit scope and had rotted furthest.reports/README.md: WandB example + integration row → current EvaluationSource/MetricFrame equivalents.config/_reporting.py: the canonical-metrics comment no longer claims tokens must match "the WandB run summary."Withdrawn during investigation (the protocol earning its keep)
Deleting
find_item_namesas dead code — it's alive: called intra-file bysearch_for_item_name(utils.py:118); the initial use-site grep had excluded the defining file. No deletion.Deferred (documented, deliberately NOT registered — Tier-4 observations)
sys.path.inserttest idiom ·dataset_statistics.pyname misnomer (C-185 umbrella) · mapping.py/report.py module size · the twin frame helpers (legitimate specialization).Gates
Zero behaviour change (docs/comments only) ·
ruffclean · 362 passed, 2 skipped, 1 xfailed🤖 Generated with Claude Code