Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Bug]: CancelOrderResponse not returned by TradingClient.cancel_order_by_id like documentation says #508

Open
2 tasks done
kwilsonmg opened this issue Sep 21, 2024 · 0 comments

Comments

@kwilsonmg
Copy link
Contributor

kwilsonmg commented Sep 21, 2024

Is there an existing issue for this?

  • I have searched the existing issues

Current Behavior

The documentation for TradingClient.cancel_order_by_id says that it returns a CancelOrderResponse object. However, it does not and the type hint indicates as such. This is a contradiction.

Expected Behavior

The quickest solution would be to update the documentation to reflect that it doesn't do this and returns None (see #78 ), the longer solution would be #78.

SDK Version I encountered this issue in

any modern version, including master

Steps To Reproduce

Try and use function (noting its lack of a return value) or read [the documentation](https://alpaca.markets/sdks/python/api_reference/trading/orders.html)

Filled out the Steps to Reproduce section?

  • I have entered valid steps to reproduce my issue or have attached a minimally reproducible case in code that shows my issue happening; and understand that without this my issue will be flagged as invalid and closed after 30 days.

Anything else?

No response

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant