Clarify commission parameter in README usage example#1364
Closed
mastroke wants to merge 1 commit into
Closed
Conversation
Explain that commission=.002 means a 0.2% per-trade fee and point readers to spread and callable commission options in the API docs. Co-authored-by: Cursor <cursoragent@cursor.com>
Owner
|
The readme is meant to be brief, glance-friendly. Cursor may disagree, but the interested user is expected to RTFM. Other parameters are not similarly explained, etc. |
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
2 participants
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
commission=.002as a 0.2% per-trade feespreadand callable commission in the API referenceMotivation
New users often miss that the commission argument is a fraction of traded value. The quick-start docs mention 0.2% in prose, but the README code sample does not.
Test plan
Made with Cursor