Add return type annotations for buy and sell methods #975
Conversation
This file contains 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
Type annotations are now explicitly imported from `__future__` to allow forward references and postponed evaluation (faster import time). See PEP 563 for details.
The return type annotations are now added for `buy` and `sell` methods. The documentation is updated to mention that the `Order` is returned. Now it should be crystal clear how to cancel a non-executed order. This should address kernc#957.
kernc
approved these changes
May 3, 2023
|
Thank you for the review, @kernc! I have not used github for quite some time, hehe. The doc suggests that you might need to approve workflow runs as I'm the first time contributor. Could you click the button for me, please? |
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.
The return type annotations are now added for
buyandsellmethods. The documentation is updated to mention that theOrderis returned. Now it should be crystal clear how to cancel a non-executed order (#957).Additionally, annotations are now explicitly imported everywhere to improve compatibility and importing time.