Commit 0638426
Address PR #372 R12 review (1 P2): Survey Support section overstates uniform contract
P2 - README.md L131-137 advertised "all estimators accept survey_design"
with "weight types pweight/fweight/aweight" as a uniform contract, but:
- HeterogeneousAdoptionDiD.fit() uses survey= / weights= (not survey_design=)
- HAD continuous path rejects non-pweight survey designs
- CallawaySantAnna and StackedDiD are also pweight-only
A reader could reasonably try `SurveyDesign(..., weight_type="aweight")`
on any estimator and hit a NotImplementedError.
Rewrite the Survey Support section to:
- Say "Most" not "All" estimators accept survey_design, with explicit
callout of HAD's distinct survey= / weights= API
- Defer per-estimator weight-type support to the existing compatibility
matrix on RTD instead of claiming uniform pweight/fweight/aweight
- Note explicitly that some surfaces (CS, StackedDiD, HAD continuous)
are pweight-only while others accept all three weight types
- Cite Binder (1983) for TSL alongside the methods list
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>1 parent 41107c8 commit 0638426
1 file changed
Lines changed: 3 additions & 4 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
128 | 128 | | |
129 | 129 | | |
130 | 130 | | |
131 | | - | |
| 131 | + | |
132 | 132 | | |
133 | | - | |
134 | | - | |
| 133 | + | |
| 134 | + | |
135 | 135 | | |
136 | 136 | | |
137 | | - | |
138 | 137 | | |
139 | 138 | | |
140 | 139 | | |
| |||
0 commit comments