fix-audit-405-r2: mirror PR #405 CV notation + bacon Parameters fix into sibling surfaces#444
Open
igerber wants to merge 1 commit into
Open
fix-audit-405-r2: mirror PR #405 CV notation + bacon Parameters fix into sibling surfaces#444igerber wants to merge 1 commit into
igerber wants to merge 1 commit into
Conversation
…ram block PR #405 changed coef_var docstrings from "SE / |ATT|" to "SE / abs(ATT)" to avoid Sphinx interpreting |...| as a substitution reference, but did not mirror the same change into the user-facing summary labels rendered by summary() / print(). The result: docstrings now describe the metric as "SE/abs(ATT)" while the terminal prints "CV (SE/|ATT|):" — two labels for the same quantity. Mirror the notation across all 14 summary call sites and update the single cached T18 tutorial output that quotes the label: - diff_diff/results.py (3 sites: DiD/MultiPeriod/SyntheticDiD) - diff_diff/{continuous_did,efficient_did,imputation,stacked_did, staggered,staggered_triple_diff,trop,two_stage}_results.py (1 each) - diff_diff/sun_abraham.py (1) - diff_diff/chaisemartin_dhaultfoeuille_results.py (dynamic f"CV (SE/|{label}|):" -> f"CV (SE/abs({label})):") - docs/tutorials/18_geo_experiments.ipynb (1 cached output line) Also mirror PR #405's blank-line-before-bullet-list fix into BaconDecomposition.__init__ at bacon.py:404, matching the same fix already applied to bacon_decompose() at bacon.py:1086 and 1097 by PR #405. This Parameters block is rendered through docs/api/_autosummary/diff_diff.BaconDecomposition.rst. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
Overall Assessment ✅ Looks good: highest unmitigated severity is P3/informational only. Executive Summary
Methodology
Code Quality
Performance
Maintainability
Tech Debt
Security
Documentation/Tests
|
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
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.
Summary
Holistic-audit fix-PR for #405 (
docs: fix 86 Sphinx ERRORs across docstring substitutions and indentation). Pilot at /tmp/pilot-405-wt cherry-picked #405 onto its pre-merge base and ran iterative codex review (R0 + R1 with gpt-5.4 + xhigh reasoning).R0 surfaced one actionable P3 (cross-surface notation consistency): #405 changed
coef_vardocstrings fromSE / |ATT|toSE / abs(ATT)(the bar form triggered Sphinx substitution-reference interpretation), but did not mirror the same change into the user-facing summary labels rendered bysummary()/print(). R1 confirms clean ✅.This PR mirrors PR #405's notation update into:
CV (SE/|ATT|):→CV (SE/abs(ATT)):(and the dynamic chaisemartin labelf"CV (SE/|{label}|):"→f"CV (SE/abs({label})):")BaconDecomposition.__init__Parameters block atbacon.py:404— blank line before bullet list (same fix docs: fix 86 Sphinx ERRORs (PR 1 of 2-PR cleanup) #405 already applied tobacon_decompose())nbsphinx_execute = "never")No methodology impact — pure rendered-surface consistency fix.
Test plan