Skip to content

Document estimator aliases for user discoverability#198

Merged
igerber merged 2 commits intomainfrom
docs/estimator-alias-discoverability
Mar 15, 2026
Merged

Document estimator aliases for user discoverability#198
igerber merged 2 commits intomainfrom
docs/estimator-alias-discoverability

Conversation

@igerber
Copy link
Owner

@igerber igerber commented Mar 15, 2026

Summary

  • Add alias reference table to README (13 aliases mapped to full names and methods)
  • Show # or: DiD comment on Quick Start import in README
  • Upgrade quickstart.rst alias tip from Python comment to RST .. tip:: admonition
  • Add (alias: ...) labels to all 5 estimator headings in API docs
  • Fix wrong alias names in CHANGELOG (DIDDiD, MPIDEventStudy, CSANCS, SDIDSDiD)

Methodology references (required if estimator / math changes)

  • N/A — no methodology changes

Validation

  • Tests added/updated: No test changes (documentation only)
  • All 13 aliases verified importable: python -c "from diff_diff import DiD, TWFE, EventStudy, SDiD, CS, CDiD, SA, BJS, Gardner, DDD, Stacked, Bacon, EDiD"
  • Alias names cross-checked against diff_diff/__init__.py lines 167-180

Security / privacy

  • Confirm no secrets/PII in this PR: Yes

Generated with Claude Code

igerber and others added 2 commits March 15, 2026 10:05
Add alias reference table to README, show alias comment in Quick Start
import, upgrade quickstart.rst tip to RST admonition, add alias labels
to API doc estimator headings, and fix wrong alias names in CHANGELOG.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@igerber
Copy link
Owner Author

igerber commented Mar 15, 2026

/ai-review

@github-actions
Copy link

🔁 AI review rerun (requested by @igerber)

Head SHA: 69574a644df8609fb9d1caf67979449b7b7dcb82


Overall Assessment

✅ Looks good

Executive Summary

  • This is a docs-only PR. I found no changes to estimator logic, identification assumptions, weighting, variance/SE computation, or defaults, so there is no methodology regression against the registry.
  • The alias names documented in the README and changelog are consistent with the public exports in diff_diff/init.py#L168, diff_diff/init.py#L180, and diff_diff/init.py#L244.
  • Severity: P3. The new quickstart tip points readers to api/estimators for the “full list,” but that page’s alias example omits EDiD, which is a public alias. This is already tracked as EfficientDiD API-doc debt in TODO.md#L49.
  • Severity: P3. The new README section is titled “Estimator Aliases,” but it includes Bacon, which is a decomposition/diagnostic rather than an estimator.
  • I could not rerun the PR-body import smoke test in this environment because numpy is not installed; I verified alias existence from source exports instead.

Methodology

Code Quality

  • No findings.

Performance

  • No findings.

Maintainability

  • No findings.

Tech Debt

Security

  • No findings. Docs-only changes and no obvious secret exposure.

Documentation/Tests

  • Severity: P3. Impact: README.md#L87 introduces an “Estimator Aliases” table, but README.md#L104 includes Bacon, which maps to BaconDecomposition. The methodology registry classifies Bacon under Diagnostics & Sensitivity at docs/methodology/REGISTRY.md#L22, and the class itself is documented as a TWFE decomposition at diff_diff/bacon.py#L288. Concrete fix: rename the section to something like “Public Aliases” or split Bacon into a separate diagnostic-alias note.
  • No testing finding from the diff. I could not rerun the alias-import smoke test locally because the review environment is missing numpy.

@igerber igerber merged commit c58ee71 into main Mar 15, 2026
@igerber igerber deleted the docs/estimator-alias-discoverability branch March 15, 2026 14:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant