Skip to content

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

@kwilsonmg

Description

@kwilsonmg

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions