docs: add comprehensive explanation of order results - #579
Merged
fasenderos merged 2 commits intoJun 27, 2026
Conversation
Add detailed 'Understanding Order Results' section to README explaining: - When taker orders appear in result arrays - Difference between done/partial for limit vs market orders - Meaning of partialQuantityProcessed - Practical examples for all scenarios This documentation helps developers better understand the IProcessOrder return value and avoid common confusion about taker order placement.
Owner
|
thank you :) |
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.
Add detailed 'Understanding Order Results' section to README explaining:
This documentation helps developers better understand the IProcessOrder return value and avoid common confusion about taker order placement. I was struggling to understand how I could have a single order in
doneand no partial order, it took me a while to fully understand what was actually going wrong 😅