Repository navigation
docs: correct rebalancing controls, sizing bounds and API descriptions - #147
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.
Closes #145
Changes
Correct the rebalancing and configuration guides and the existing RebalanceMode, RebalanceConfig and TargetWeightExecutor.execute descriptions. Add their API destinations to the reference and link the guide directly to them.
Behavior evidence
Native Backtrader 1.9.78.123 with $100,000 cash, three bars at $100 and order_target_percent(target=1.0) requested and filled 1,000 shares. The guide's claimed 0.998 default would have produced 998.
A real public Backtest Engine run with max_single_weight=0.25, whole shares, $100,000 equity and $150 prices filled 167 shares: $25,050 notional and 25.05% exposure. The corrected guide states that rounding can exceed the nominal target.
Both modified Python files have identical executable ASTs after removing docstrings. The diff changes descriptions only.
Validation evidence
Source-hash checks include docstrings, so the correctness records were regenerated through the existing producers at source commit 5c87d0c:
Selected head 37b1a54 incorporates merged backend main 62adafa. Its src/, docs/ and validation/ bytes are identical to the locally qualified tree at 0a0d954. The refresh imports only the backend requirement already merged separately. Fresh strict docs, links, generated claims, hooks and rendered version/commit identity checks passed at this exact head. Applicable hosted checks and package qualification remain required before ordinary merge.
AI assistance
Codex inspected the producing implementation, reproduced the native and public Engine examples, corrected the prose, verified AST equivalence, regenerated correctness evidence and ran the existing timing-certification command and checks. Codex drafted this description. No independent human review or universal framework equivalence claim is asserted.
Release, tag, publication and deployment remain separate decisions.