Correct User Guide API examples and stateful claims - #122
Merged
Merged
Conversation
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.
Why
The published Stateful Strategies guide and linked example module say VectorBT cannot model decisions that depend on simulated fills. VectorBT's documented
Portfolio.from_order_funcsupports state-dependent order generation. The pairs example also presents independent orders without guaranteeing both legs fill. The Accounts guide passes account settings as unsupportedEngineconstructor keywords. The Risk Management guide contains 11 unsupported rule and limit keywords and describes an ATR stop as a standard-deviation stop.Changes
BacktestConfig, and run its standalone short-sale example in the installed-wheel documentation check.AccountState,UnifiedAccountPolicy, andNoCommission.Verification
uv run mkdocs build --strictpassed.validation/check_documentation_links.pychecked 2,041 rendered guide links and 30 external destinations.validation/check_book_links.pychecked 22 pinned companion paths.Refs #120. These corrections do not close the full User Guide audit.