Repository navigation
chore: docstring + naming + repr cleanup, bump 0.0.6 (closes #78) - #79
Merged
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #79 +/- ##
=====================================
Coverage 92.2% 92.2%
=====================================
Files 27 27
Lines 1172 1167 -5
Branches 114 114
=====================================
- Hits 1081 1077 -4
+ Misses 68 67 -1
Partials 23 23 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
thomaspinder
force-pushed
the
audit/03-extract-helpers
branch
from
May 18, 2026 21:55
04cbae5 to
f450066
Compare
Wraps up the spring-cleaning stack. Individually small fixes that cluster naturally into one style PR. - src/impulso/volatility.py: `Constant.cholesky_path` / `forecast_cholesky_path` docstrings reference `L` (the actual posterior key after #69) instead of `Sigma`; cross-ref `Constant.cholesky_at` as the canonical accessor. - src/impulso/sv/data.py: `_MIN_OBS` is now `ClassVar[int] = 24` — makes the class-attribute intent explicit instead of relying on Pydantic's implicit underscore handling. - src/impulso/fitted.py: `FittedVAR.has_exog` drops `@computed_field` (now a plain `@property`) so it stops appearing in `model_dump()`. - src/impulso/sv/dynamics.py: `RandomWalk.build_latent_path` / `AR1.build_latent_path` swap `Any` for `"pt.TensorVariable"` forward refs that match the SVDynamics Protocol declaration; drop the now-unused `Any` import. - src/impulso/results.py: delete `VARResultBase.__repr__` override — Pydantic's default produces a useful compact repr because every `idata` field has `Field(repr=False)`. - src/impulso/**/*.py: docstring sweep — double backticks (RST) → single backticks (Markdown / mkdocstrings); no more `:meth:` / `:class:` cross-refs (replaced with plain backticked names in earlier passes). - CLAUDE.md: codify the docstring convention under "Code Conventions". - src/impulso/identified.py: delete `forecast_error_variance_decomposition`; `fevd` is the canonical name. Docstring + .qmd / .md cross-references updated. - pyproject.toml + uv.lock: bump `0.0.5 → 0.0.6` to ship the cumulative audit cleanup (#73 + #75 + #77 + this PR). Closes audit findings #5, #8, #12, #13, #14, #15, #16 (reports/audit-2026-05-18.md). Breaking (pre-v0.1): callers of `IdentifiedVAR.forecast_error_variance_decomposition` must use `IdentifiedVAR.fevd` (no signature change). The long name was always an alias; per repo policy pre-v0.1 API breaks are in scope. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
thomaspinder
force-pushed
the
audit/04-style-sweep
branch
from
May 18, 2026 22:05
b117cd4 to
6ed2c7e
Compare
This branch was previously deployed
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
Wraps up the audit cleanup stack — small individual fixes that share a single style/cleanup theme.
volatility.py:Constant.cholesky_path/forecast_cholesky_pathdocstrings now referenceL(the actual posterior key) instead of staleSigma; cross-refConstant.cholesky_at.sv/data.py:_MIN_OBS: ClassVar[int] = 24— explicit class-attribute intent.fitted.py:FittedVAR.has_exogdrops@computed_field; plain@propertynow, so it's no longer inmodel_dump().sv/dynamics.py:RandomWalk/AR1build_latent_pathuse"pt.TensorVariable"forward refs instead ofAny.results.py: deleteVARResultBase.__repr__override — Pydantic's default repr is already compact thanks toField(repr=False)onidata.src/impulso/**/*.py: docstring sweep — double backticks (RST) → single backticks (Markdown / mkdocstrings); no:meth:/:class:cross-refs anywhere.identified.py: deleteforecast_error_variance_decomposition;fevdis the canonical name. Tutorial.qmd+.mdupdated.CLAUDE.md: codify the docstring convention.pyproject.toml+uv.lock: bump0.0.5 → 0.0.6.Closes #78. Final layer of the 4-PR audit stack, stacked on top of #77 (PR3).
Breaking changes (pre-v0.1)
IdentifiedVAR.forecast_error_variance_decompositionremoved. Migrate toIdentifiedVAR.fevd(same signature). Long name was always an alias.Test plan
make test— 281/281 pass.make check— ruff + ty clean;uv lock --lockedmatchespyproject.toml.make docs-render-ci— clean, exit 0.grep -r forecast_error_variance_decomposition src/ tests/ docs/— no matches (gate 3).grep -rn ':meth:\|:class:' src/— no matches (gate 4).grep -rn '\`' src/` — no matches (gate 5).SVData._MIN_OBSnot inmodel_fields(gate 6).FittedVAR(...).model_dump()does not includehas_exog(gate 7).repr(ForecastResult(...))showssteps=4, var_names=['a', 'b'], noidata(gate 8).pyproject.tomlshowsversion = "0.0.6"(gate 9).🤖 Generated with Claude Code