docs: add docstrings for order generators, WeightStrategyBase, and Exchange #2115
+177
−50
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
…change Addresses gaps in trading class documentation: - OrderGenerator: add class docstring explaining the two built-in implementations and their weight-normalisation differences - OrderGenWInteract: document weight re-normalisation across tradable stocks for full capital utilisation - OrderGenWOInteract: document prediction-date price estimation and the fact that untradable stocks are skipped (not re-allocated) - WeightStrategyBase: document order generator selection, explain the factor field requirement for round-lot trading - Exchange.limit_threshold: clarify the three modes (None/float/tuple) with concrete examples and default values by region - Exchange.get_factor: explain the adjustment factor's role in round-lot order rounding via trade_unit Closes microsoft#2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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
OrderGenerator,OrderGenWInteract, andOrderGenWOInteractexplaining weight normalisation differences and capital utilisation behaviourWeightStrategyBaseclass with guidance on order generator selection and the$factorfield requirement for round-lot tradingExchange.limit_thresholdparameter: the three modes (None,float,Tuple[str, str]) with examples and per-region defaultsExchange.get_factorexplaining the adjustment factor's role inround_amount_by_trade_unitTest plan
Closes #2026