docs: utility coverage gaps (RTD audit Batch C)#403
Merged
Conversation
…llms-autonomous.txt Closes three RTD coverage gaps surfaced during the docs audit: 1. profile_panel and its 4 supporting dataclasses (PanelProfile, OutcomeShape, TreatmentDoseShape, Alert) are public top-level exports but had no API reference. New docs/api/profile.rst covers all 5 symbols under a new "Pre-Fit Profiling" toctree section. 2. The 11 top-level local-linear infrastructure symbols (kernels, kernel_moments, local_linear_fit, mse_optimal_bandwidth, bias_corrected_local_linear, and their result dataclasses) had no API reference. New docs/api/local_linear.rst covers all 11 under a new "Infrastructure" toctree section (sibling to Estimators, not a peer of HAD/EfficientDiD - the symbols are building blocks HAD composes). 3. llms-autonomous.txt (65KB) shipped in the wheel but was not exposed via Sphinx. Added to docs/conf.py html_extra_path; the practitioner-profile prose link in profile.rst now resolves on RTD. doc-deps.yaml: extends existing local_linear.py entry to point at the new api/local_linear.rst; adds new diff_diff/profile.py top-level entry at drift_risk: low (descriptive-only by design, sits with prep.py / datasets.py not the linalg.py / utils.py methodology-stake tier). Drive-by: 1-line RST formatting fix in BaconDecomposition Parameters docstring (blank line before bullet list) noticed during the deferred Sphinx -W investigation. Verification: sphinx make html shows zero warnings on the three new/edited files (pre-existing -W backlog out of scope). Rendered HTML confirms all 16 new symbols render and llms-autonomous.txt is served from html_extra_path. test_doc_snippets.py: 111 passed, 4 skipped (unchanged baseline; new RST files contain no code-blocks). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
Overall Assessment No unmitigated P0/P1 issues in the changed files. The diff is docs-only apart from a docstring whitespace fix, and I found one P3 informational documentation mismatch in the new Executive Summary
Methodology
Code Quality
Performance
Maintainability
Tech Debt
Security
Documentation/Tests
|
Tighten the local_linear.rst overview to distinguish the generic helpers from the HAD-scoped public wrappers, surfacing the Phase 1b/1c contract that lives in REGISTRY.md and the source docstrings: - Generic helpers (local_linear_fit, kernels, kernel_moments, KERNELS) remain usable on their own for any one-sided boundary local-linear regression problem with a strictly nonnegative running variable. - HAD-scoped wrappers (mse_optimal_bandwidth, bias_corrected_local_linear) are explicitly hard-coded to the HAD Phase 1b/1c configuration and only those settings are parity-tested against R nprobust. Callers needing the broader surface drop to diff_diff._nprobust_port and accept that parity is not verified. Cross-references diff_diff/local_linear.py:695-705 (Phase 1b), :972-980 (Phase 1c), and REGISTRY.md HeterogeneousAdoptionDiD section for the full contract. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Owner
Author
|
/ai-review |
|
🔁 AI review rerun (requested by @igerber) Head SHA: Overall Assessment Executive Summary
Methodology
Code Quality
Performance
Maintainability
Tech Debt
Security
Documentation/Tests
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
RTD audit Batch C closes three utility-coverage gaps surfaced during the
docs refresh initiative:
docs/api/profile.rst- coversprofile_panelplus the foursupporting dataclasses (
PanelProfile,OutcomeShape,TreatmentDoseShape,Alert). All five are public top-level exportsbut had no API reference. Lands under a new "Pre-Fit Profiling" toctree
section in
docs/api/index.rst.docs/api/local_linear.rst- covers all 11 top-levellocal-linear infrastructure symbols (kernels, kernel-moment constants,
local_linear_fit,mse_optimal_bandwidth,bias_corrected_local_linear, and result dataclasses). Lands under anew "Infrastructure" toctree section. Deliberately not placed under
"Estimators" - the symbols are building blocks
HeterogeneousAdoptionDiDcomposes, not estimators themselves.
docs/conf.py-html_extra_pathnow includesllms-autonomous.txt(65KB). The file ships in the wheel but was notpreviously exposed via Sphinx, so the practitioner-profile prose link
to it from
profile.rst:11now resolves on RTD.docs/doc-deps.yaml: extends the existinglocal_linear.pyentry topoint at the new
api/local_linear.rst; adds a new top-leveldiff_diff/profile.pyentry atdrift_risk: low(descriptive-only bydesign, sits with
prep.py/datasets.pynot thelinalg.py/utils.pymethodology-stake tier).Drive-by: 1-line RST formatting fix in
BaconDecompositionParametersdocstring (blank line before bullet list) noticed during the deferred
Sphinx
-Winvestigation.Methodology references (required if estimator / math changes)
diff_diff/bacon.pyis touched insource, and only the RST formatting of an existing docstring (no logic,
no signature, no semantics).
Validation
The new RST files contain no
.. code-block:: pythondirectives, sotests/test_doc_snippets.pyreports zero new cases.tests/test_doc_snippets.pybaseline (locally, pure-Python backend):111 passed, 4 skipped (unchanged from origin/main; new files
introduce no snippets).
-W): zero warnings onprofile.rst,local_linear.rst,index.rst, zero newautosummary stubwarnings. Pre-existing backlog of 2,200+ warnings on other files stays
out of scope (deferred to a separate
-Wcleanup PR).local-linear symbols render in their respective pages;
docs/_build/html/llms-autonomous.txtis served fromhtml_extra_path;profile.htmlcontains exactly onehref="../llms-autonomous.txt"matching the prose link.
Security / privacy
Generated with Claude Code