orders: rename good_till_cancel to good_till_canceled - #826
Merged
Merged
Conversation
The setter sets TimeInForce::GoodTillCanceled and sits next to day_till_canceled(); it was the one TIF setter whose name matched neither. #822 spent the breaking change on this spelling everywhere else, so finish it in the same release rather than pay for it again after 4.0 ships. Updates the four in-tree call sites, the README and docs/order-types.md snippets (which nothing compiles), and migration §13.
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
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.
Review follow-up from #822 (finding #6).
OrderBuilder::good_till_cancel()setsTimeInForce::GoodTillCanceledand sits next today_till_canceled(). It was the only time-in-force setter whose name matched neither the variant it sets nor its neighbour. #822 spent the breaking change on the "till"/"canceled" spelling everywhere else; doing this now means not paying for it again after 4.0 ships.Hard rename, no deprecated alias — consistent with how §13 handles the rest of the enum.
day_till_canceled()now say "canceled", matching the variant.sync_tests.rs,async_tests.rs, two in the builder tests).README.mdanddocs/order-types.mdsnippets updated — nothing compiles those fenced blocks, so they were checked by reading.Gate:
cargo fmt --check, three clippy legs,just test(6 legs), rustdoc-D warnings, examples on both feature configs, both integration crates,just rules-check.