Skip to content

Commit 2e6cbe2

Browse files
igerberclaude
andcommitted
Fix CI review R7: update survey_metadata docstring
The results dataclass docstring still described survey_metadata as 'always None' and survey integration as deferred. survey_design is now implemented and results.survey_metadata is populated whenever a SurveyDesign is passed to fit(). Docstring now describes the populated field and its role in survey-aware inference and HonestDiD propagation. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 8b6a6b1 commit 2e6cbe2

1 file changed

Lines changed: 7 additions & 2 deletions

File tree

diff_diff/chaisemartin_dhaultfoeuille_results.py

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -342,8 +342,13 @@ class ChaisemartinDHaultfoeuilleResults:
342342
``compute_honest_did(results)`` post-hoc. Contains identified
343343
set bounds, robust confidence intervals, and breakdown analysis.
344344
survey_metadata : Any, optional
345-
Always ``None`` in Phase 1 — survey integration is deferred to a
346-
separate effort after all phases ship.
345+
Populated when ``fit(..., survey_design=sd)`` is called; ``None``
346+
otherwise. Carries the resolved survey design summary
347+
(``weight_type``, strata/PSU counts, ``df_survey``, weight range,
348+
and replicate-method info when applicable). ``df_survey`` is
349+
threaded into survey-aware inference (t-distribution at all
350+
analytical surfaces) and consumed by ``compute_honest_did()`` to
351+
produce survey-aware critical values.
347352
bootstrap_results : DCDHBootstrapResults, optional
348353
Bootstrap inference results when ``n_bootstrap > 0``.
349354
"""

0 commit comments

Comments
 (0)