Repository navigation
docs(v4): PR 5a-ii of the 4.0 cut - migrate the documented readers of the overall_* field names to the canonical quintet - #874
Conversation
… the overall_* field names to the canonical quintet Documentation half of cut-sequence item 5's reader migration (the M-050..M-058 storage flip), split from PR 5a because the combined compiled review prompt exceeded the AI review input cap. Every documented read of overall_att / overall_se / overall_t_stat / overall_p_value / overall_conf_int (and ContinuousDiD's overall_att_* spellings) on the nine flipping containers now reads att / se / t_stat / p_value / conf_int: - RTD pages (docs/*.rst, docs/api/*.rst) and the REGISTRY prose that describes a read; - the bundled llms-full / llms-practitioner / llms-autonomous guides (code examples and read-describing prose only - the field TABLES describe the stored surface and flip with the storage in PR 5b); - tutorial code cells in 02, 09, 11-17, 24, 26, 29, 30, 32 (markdown in 14/19/24/32); committed outputs are byte-identical except tutorial 18's echoed practitioner guidance string, which mirrors the PR 5a source change; - the tutorial drift tests that mirror those notebooks (t19, t24, t26, t29, t32), with tutorial 32's ALL_CODE_CELL_HASHES re-pinned to the edited cells; - benchmark scripts (attribute reads only - the R-parity output-dict keys stay) and the carousel generator. No behaviour change: the canonical names already resolve as properties. Bootstrap draw containers (bootstrap_results.overall_att_se) and StaggeredTripleDiffResults readers are untouched by design. Independent of PR 5a (different files, both based on main).
Overall assessment: ✅ Looks goodNo unmitigated P0, P1, or P2 findings identified. Executive summary
MethodologyNo findings. The migration agrees with the alias contract in Code QualityNo findings. Reader substitutions use existing properties and introduce no inference recomputation, partial NaN guards, or parameter-propagation changes. PerformanceNo findings. The changes add no substantive computation. MaintainabilityNo findings. Examples consistently promote the intended canonical interface while preserving external benchmark schemas. Tech DebtNo new untracked limitation identified. The retained storage-field tables match the explicitly described staged migration. SecurityNo findings in the supplied changes. Documentation/TestsNo findings. The per-PR changelog fragment is present, and the updated drift tests retain their numerical assertions. Static notebook and hash verification passed; estimator execution and notebook re-execution remain unverified locally because dependencies are unavailable. |
Summary
docs/v4-design.mdsection 9 item 5, theM-050..M-058storage flip - reader half, documentation). Split from PR 5a because the combined review input exceeded the AI review budget; independent of 5a (different files, both based onmain). Every documented READ of the 3.xoverall_att/overall_se/overall_t_stat/overall_p_value/overall_conf_intnames (and ContinuousDiD'soverall_att_*spellings) on the nine flipping containers now reads the canonicalatt/se/t_stat/p_value/conf_intquintet. No behaviour change: the canonical names already resolve.docs/*.rst,docs/api/*.rst; the executed snippets pass) and the one REGISTRY sentence that describes a read; the bundledllms-full/llms-practitioner/llms-autonomousguides (code examples and read-describing prose only - the field TABLES describe the stored surface and flip with the storage in PR 5b).practitioner_next_stepsguidance string mirrors the PR 5a source change. The tutorial drift tests that mirror those notebooks (t19, t24, t26, t29, t32) read the canonical names, and tutorial 32'sALL_CODE_CELL_HASHESis re-pinned to the edited cells (6 of 15 hashes)."overall_att"/"overall_se"output-dict keys thatcompare_results.pyand the R scripts exchange are an interface and stay); the carousel generator's code string.bootstrap_results.overall_att_se(tutorial 02) and the other bootstrap draw-container names,StaggeredTripleDiffResultsreaders, R / golden-JSON keys, ledger / spec / migration-guide prose.Methodology references (required if estimator / math changes)
diff_diff/*.pychange.Validation
pytest --nbmakeon the touched notebooks except 26 / 29 / 30 (the balance / pymc / meridian interop venvs; their cells are a pure attribute rename and the CI interop jobs execute them). Touched benchmark scripts:ruff checkadds no new codes versusmain.Security / privacy
Changelog
changelog.d/20261026-v4-pr5a-ii-docs-readers.md(### Internal)Follow-ups