docs: clarify period-based vs trade-based metrics#495
Merged
ranaroussi merged 1 commit intomainfrom Jan 13, 2026
Merged
Conversation
- Added section explaining that metrics like win_rate, consecutive_wins, payoff_ratio, and profit_factor are period-based (not trade-based) - Updated Python version badge to 3.10+ - Updated requirements section to match pyproject.toml Addresses concerns raised in #493 Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
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
win_rate,consecutive_wins,payoff_ratio, andprofit_factorare period-based (not trade-based)pyproject.tomlContext
Addresses concerns raised in #493 where a user noted that these metrics could be misleading for discretionary traders expecting trade-level statistics.
The documentation now clarifies:
Changes