Skip to content

Commit 1e6eef7

Browse files
igerberclaude
igerber
and
claude
committed
Address PR #372 R2 review (2 P2)
P2 - docs/doc-deps.yaml partially migrated to new doc-surface contract - Add `diff_diff/guides/llms.txt` entries to 12 estimator blocks that already had llms-full.txt (CallawaySantAnna, SunAbraham, ImputationDiD, TwoStageDiD, EfficientDiD, ContinuousDiD, StackedDiD, SyntheticDiD, TripleDifference, TROP, HonestDiD, WooldridgeDiD, ChaisemartinDHaultfoeuille, Survey). Section labels match the actual llms.txt heading the entry belongs under: "Estimators", "Diagnostics and Sensitivity Analysis" (HonestDiD), "Survey Support" (survey). - Backfill bacon.py with llms-full.txt + llms.txt entries (and the missing 02_staggered_did tutorial reference for Bacon decomposition). - Backfill staggered_triple_diff.py with full surface mapping (16_survey_did tutorial, README, references.rst, llms-full.txt, llms.txt). - Net: all 17 method-backed estimator sources now have the required README + llms.txt + llms-full.txt + references.rst entries. BusinessReport / DiagnosticReport intentionally lack llms.txt entries (not in llms.txt per their experimental-preview status). P2 - StaggeredTripleDifference API doc target - Add `.. autoclass:: diff_diff.StaggeredTripleDifference` and `StaggeredTripleDiffResults` sections to docs/api/staggered.rst. - Update docs-check.md table row from index.rst (where it was a false-pass) to staggered.rst (where the autoclass actually lives now). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent dc443d5 commit 1e6eef7

3 files changed

Lines changed: 81 additions & 1 deletion

File tree

‎.claude/commands/docs-check.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ The following estimators/features MUST have documentation:
4949
| StackedDiD | "StackedDiD" | "StackedDiD" | stacked_did.rst | "Multi-Period and Staggered" |
5050
| ContinuousDiD | "ContinuousDiD" | "ContinuousDiD" | continuous_did.rst | "Multi-Period and Staggered" |
5151
| TripleDifference | "TripleDifference" | "TripleDifference" | triple_diff.rst | "Triple Difference" |
52-
| StaggeredTripleDifference | "StaggeredTripleDifference" | "StaggeredTripleDifference" | index.rst | "Triple Difference" |
52+
| StaggeredTripleDifference | "StaggeredTripleDifference" | "StaggeredTripleDifference" | staggered.rst | "Triple Difference" |
5353
| WooldridgeDiD | "WooldridgeDiD" | "WooldridgeDiD" | wooldridge_etwfe.rst | "Multi-Period and Staggered" |
5454
| TROP | "TROP" | "TROP" | trop.rst | "Triply Robust Panel" |
5555
| HonestDiD | n/a (in `## Diagnostics`) | n/a (in `## Diagnostics`) | honest_did.rst | "Honest DiD" |

‎docs/api/staggered.rst‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,3 +123,24 @@ Bootstrap inference results for Sun-Abraham estimation.
123123
:members:
124124
:undoc-members:
125125
:show-inheritance:
126+
127+
StaggeredTripleDifference
128+
-------------------------
129+
130+
Ortiz-Villavicencio & Sant'Anna (2025) staggered triple-difference (DDD) estimator
131+
with group-time ATT identification under heterogeneous treatment timing.
132+
133+
.. autoclass:: diff_diff.StaggeredTripleDifference
134+
:members:
135+
:undoc-members:
136+
:show-inheritance:
137+
138+
StaggeredTripleDiffResults
139+
--------------------------
140+
141+
Results container for ``StaggeredTripleDifference`` estimation.
142+
143+
.. autoclass:: diff_diff.StaggeredTripleDiffResults
144+
:members:
145+
:undoc-members:
146+
:show-inheritance:

‎docs/doc-deps.yaml‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,20 @@ sources:
170170
type: methodology
171171
- path: docs/api/staggered.rst
172172
type: api_reference
173+
- path: docs/tutorials/16_survey_did.ipynb
174+
type: tutorial
175+
note: "StaggeredTripleDifference appears in survey-DiD examples"
176+
- path: README.md
177+
section: "Estimators (one-line catalog entry)"
178+
type: user_guide
179+
- path: docs/references.rst
180+
type: user_guide
181+
- path: diff_diff/guides/llms-full.txt
182+
section: "StaggeredTripleDifference"
183+
type: user_guide
184+
- path: diff_diff/guides/llms.txt
185+
section: "Estimators"
186+
type: user_guide
173187

174188
# ── SunAbraham ──────────────────────────────────────────────────────
175189

@@ -192,6 +206,9 @@ sources:
192206
- path: diff_diff/guides/llms-full.txt
193207
section: "SunAbraham"
194208
type: user_guide
209+
- path: diff_diff/guides/llms.txt
210+
section: "Estimators"
211+
type: user_guide
195212
- path: docs/choosing_estimator.rst
196213
type: user_guide
197214
- path: docs/benchmarks.rst
@@ -217,6 +234,9 @@ sources:
217234
- path: diff_diff/guides/llms-full.txt
218235
section: "ImputationDiD"
219236
type: user_guide
237+
- path: diff_diff/guides/llms.txt
238+
section: "Estimators"
239+
type: user_guide
220240
- path: docs/choosing_estimator.rst
221241
type: user_guide
222242

@@ -240,6 +260,9 @@ sources:
240260
- path: diff_diff/guides/llms-full.txt
241261
section: "TwoStageDiD"
242262
type: user_guide
263+
- path: diff_diff/guides/llms.txt
264+
section: "Estimators"
265+
type: user_guide
243266
- path: docs/choosing_estimator.rst
244267
type: user_guide
245268

@@ -263,6 +286,9 @@ sources:
263286
- path: diff_diff/guides/llms-full.txt
264287
section: "EfficientDiD"
265288
type: user_guide
289+
- path: diff_diff/guides/llms.txt
290+
section: "Estimators"
291+
type: user_guide
266292
- path: docs/choosing_estimator.rst
267293
type: user_guide
268294
- path: docs/benchmarks.rst
@@ -321,6 +347,9 @@ sources:
321347
- path: diff_diff/guides/llms-full.txt
322348
section: "ContinuousDiD"
323349
type: user_guide
350+
- path: diff_diff/guides/llms.txt
351+
section: "Estimators"
352+
type: user_guide
324353
- path: docs/choosing_estimator.rst
325354
type: user_guide
326355
- path: docs/practitioner_decision_tree.rst
@@ -347,6 +376,9 @@ sources:
347376
- path: diff_diff/guides/llms-full.txt
348377
section: "SyntheticDiD"
349378
type: user_guide
379+
- path: diff_diff/guides/llms.txt
380+
section: "Estimators"
381+
type: user_guide
350382
- path: docs/practitioner_decision_tree.rst
351383
section: "Few Test Markets"
352384
type: user_guide
@@ -375,6 +407,9 @@ sources:
375407
- path: diff_diff/guides/llms-full.txt
376408
section: "TripleDifference"
377409
type: user_guide
410+
- path: diff_diff/guides/llms.txt
411+
section: "Estimators"
412+
type: user_guide
378413
- path: docs/choosing_estimator.rst
379414
type: user_guide
380415

@@ -398,6 +433,9 @@ sources:
398433
- path: diff_diff/guides/llms-full.txt
399434
section: "StackedDiD"
400435
type: user_guide
436+
- path: diff_diff/guides/llms.txt
437+
section: "Estimators"
438+
type: user_guide
401439
- path: docs/choosing_estimator.rst
402440
type: user_guide
403441

@@ -421,6 +459,9 @@ sources:
421459
- path: diff_diff/guides/llms-full.txt
422460
section: "WooldridgeDiD"
423461
type: user_guide
462+
- path: diff_diff/guides/llms.txt
463+
section: "Estimators"
464+
type: user_guide
424465
- path: docs/choosing_estimator.rst
425466
type: user_guide
426467

@@ -444,6 +485,9 @@ sources:
444485
- path: diff_diff/guides/llms-full.txt
445486
section: "TROP"
446487
type: user_guide
488+
- path: diff_diff/guides/llms.txt
489+
section: "Estimators"
490+
type: user_guide
447491
- path: docs/choosing_estimator.rst
448492
type: user_guide
449493
- path: docs/performance-plan.md
@@ -469,6 +513,9 @@ sources:
469513
- path: diff_diff/guides/llms-full.txt
470514
section: "HonestDiD"
471515
type: user_guide
516+
- path: diff_diff/guides/llms.txt
517+
section: "Diagnostics and Sensitivity Analysis"
518+
type: user_guide
472519

473520
# ── BaconDecomposition ───���─────────────────────────────────────────
474521

@@ -480,11 +527,20 @@ sources:
480527
type: methodology
481528
- path: docs/api/bacon.rst
482529
type: api_reference
530+
- path: docs/tutorials/02_staggered_did.ipynb
531+
type: tutorial
532+
note: "Bacon decomposition diagnostics for staggered DiD"
483533
- path: README.md
484534
section: "Estimators (one-line catalog entry)"
485535
type: user_guide
486536
- path: docs/references.rst
487537
type: user_guide
538+
- path: diff_diff/guides/llms-full.txt
539+
section: "BaconDecomposition"
540+
type: user_guide
541+
- path: diff_diff/guides/llms.txt
542+
section: "Estimators"
543+
type: user_guide
488544

489545
# ── Diagnostics & analysis ───────���─────────────────────────────────
490546

@@ -582,6 +638,9 @@ sources:
582638
- path: diff_diff/guides/llms-full.txt
583639
section: "Survey"
584640
type: user_guide
641+
- path: diff_diff/guides/llms.txt
642+
section: "Survey Support"
643+
type: user_guide
585644
- path: docs/choosing_estimator.rst
586645
section: "Survey Design Support"
587646
type: user_guide

0 commit comments

Comments
 (0)