Skip to content

Commit 44f2632

Browse files
igerberclaude
andcommitted
Address PR #372 R4 review (1 P2, 1 P3) + rebase onto main
(Branch rebased onto origin/main first - 32 landed commits replayed cleanly, zero file overlap with the docs-refresh changeset.) P2 - llms-practitioner.txt Step 6 inconsistent on dCDH HonestDiD support - The high-level workflow surfaces (README, bundled llms.txt) and the practitioner guide's estimator tree (L177-180) all advertise compute_honest_did(results) on MultiPeriodDiD / CallawaySantAnna / ChaisemartinDHaultfoeuille, but Step 6 still said "MultiPeriodDiD and CallawaySantAnna only". - Update Step 6 to add dCDH with the registry caveats: requires L_max >= 1, bounds use placebo estimates as pre-period coefficients (not standard event-study pre-treatment coefficients), uses diagonal variance (no full VCV available), emits UserWarning. Cross-references the REGISTRY.md "Note (HonestDiD integration)" entry under ChaisemartinDHaultfoeuille for the full caveat list. P3 - docs/doc-deps.yaml unsectioned llms.txt entries - Add `section: "Estimators"` to the 5 remaining unsectioned `diff_diff/guides/llms.txt` mappings (estimators.py, staggered.py, chaisemartin_dhaultfoeuille.py, results.py, __init__.py). Now every llms.txt mapping in doc-deps.yaml carries a section label, matching the new "first-class documentation surface" contract. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent fe120eb commit 44f2632

2 files changed

Lines changed: 17 additions & 4 deletions

File tree

diff_diff/guides/llms-practitioner.txt

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -293,11 +293,19 @@ print(results.summary())
293293

294294
This step is CRITICAL and most often skipped. Run at least one of:
295295

296-
### HonestDiD (Rambachan & Roth 2023) recommended
296+
### HonestDiD (Rambachan & Roth 2023) - recommended
297297
Bounds on the treatment effect under violations of parallel trends.
298-
Works with MultiPeriodDiD and CallawaySantAnna results only. For CS,
299-
requires `aggregate='event_study'` or `aggregate='all'` so that event
300-
study effects are available.
298+
Works with MultiPeriodDiD, CallawaySantAnna, and ChaisemartinDHaultfoeuille
299+
(dCDH) results.
300+
301+
- For CS: requires `aggregate='event_study'` or `aggregate='all'` so that
302+
event study effects are available.
303+
- For dCDH: requires `L_max >= 1` (multi-horizon mode). Bounds use placebo
304+
estimates `DID^{pl}_l` as pre-period coefficients rather than standard
305+
event-study pre-treatment coefficients, and use diagonal variance (no
306+
full VCV available for dCDH); a `UserWarning` is emitted at runtime.
307+
See `docs/methodology/REGISTRY.md` "Note (HonestDiD integration)" under
308+
ChaisemartinDHaultfoeuille for the full caveats.
301309

302310
```python
303311
from diff_diff import compute_honest_did

docs/doc-deps.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,7 @@ sources:
102102
section: "DifferenceInDifferences"
103103
type: user_guide
104104
- path: diff_diff/guides/llms.txt
105+
section: "Estimators"
105106
type: user_guide
106107
- path: docs/choosing_estimator.rst
107108
type: user_guide
@@ -145,6 +146,7 @@ sources:
145146
section: "CallawaySantAnna"
146147
type: user_guide
147148
- path: diff_diff/guides/llms.txt
149+
section: "Estimators"
148150
type: user_guide
149151
- path: docs/choosing_estimator.rst
150152
type: user_guide
@@ -314,6 +316,7 @@ sources:
314316
section: "ChaisemartinDHaultfoeuille"
315317
type: user_guide
316318
- path: diff_diff/guides/llms.txt
319+
section: "Estimators"
317320
type: user_guide
318321
- path: docs/choosing_estimator.rst
319322
type: user_guide
@@ -690,6 +693,7 @@ sources:
690693
section: "Results API"
691694
type: user_guide
692695
- path: diff_diff/guides/llms.txt
696+
section: "Estimators"
693697
type: user_guide
694698
- path: docs/methodology/REGISTRY.md
695699
section: "SyntheticDiD"
@@ -758,6 +762,7 @@ sources:
758762
drift_risk: low
759763
docs:
760764
- path: diff_diff/guides/llms.txt
765+
section: "Estimators"
761766
type: user_guide
762767
note: "Public API surface"
763768

0 commit comments

Comments
 (0)