Repository navigation
docs: verify legacy migration paths on published packages - #95
Merged
Merged
Conversation
stefan-jansen
marked this pull request as ready for review
October 13, 2026 18:06
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.
Extend the existing Pyfolio/Alphalens guide and add one selected Empyrical metric guide with a runnable shared-input comparison. Ten complete-input portfolio metrics are covered; annualization, risk-free units, NaN VaR, alpha/stability differences, unsupported grouped/group-neutral behavior and full-tearsheet limits are explicit. Sharpe and beta are dimensionless. The guide command uses --task all explicitly; the script's base-dependency default remains runnable.
Current head df7c7ca is based on main dc9768c. Stable patch ID cd13e87835697d12e9d57bb0bf9c5533b16d0ee4 proves the focused docs/example diff is unchanged from original tested head 942f367.
Fresh checks at this head:
Working revision-pinned guides (actual GET 200):
The guides link existing purged-validation and Backtest reporting workflows as supported reasons to evaluate Diagnostic. No speed or full API-replacement claim is made. Merging updates source documentation only; canonical website deployment and package publication are separate user decisions.
AI assistance: Codex prepared the docs/example, reproduced the public workflows, reviewed the focused diff and ran the checks. Maintainer accountability remains required.
Closes #94.