Commit 1a20c16
Document R7 P1 + R8 P1 fit-time guards in SyntheticDiD.fit() docstring
The ``Raises`` section of ``SyntheticDiD.fit()`` previously only listed
"non-pweight survey design" among its ``ValueError`` conditions. The
two fit-time guards added in PR #355 R7 and R8 are not reflected in
the docstring:
- R7 P1: zero total survey mass on either arm.
- R8 P1: ``fpc`` declared without explicit ``psu=`` where ``fpc``
is below the (per-stratum) unit count.
Both raise ``ValueError`` before the bootstrap loop is dispatched.
Expanding the ``Raises`` section makes the contract explicit to
readers (and AI reviewers) cross-referencing the documented behavior
against the implementation.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>1 parent f60ece2 commit 1a20c16
1 file changed
Lines changed: 15 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
270 | 270 | | |
271 | 271 | | |
272 | 272 | | |
273 | | - | |
| 273 | + | |
| 274 | + | |
| 275 | + | |
| 276 | + | |
| 277 | + | |
| 278 | + | |
| 279 | + | |
| 280 | + | |
| 281 | + | |
| 282 | + | |
| 283 | + | |
| 284 | + | |
| 285 | + | |
| 286 | + | |
| 287 | + | |
274 | 288 | | |
275 | 289 | | |
276 | 290 | | |
| |||
0 commit comments