map.draw_rectangle API is inconsistent with submap

[Cadair]

submap uses top right and bottom left and draw rectangle uses bottom right width and height. This is stupid.

This is especially stupid as it prevents you from plotting a rectangle in the coordinates of one image over another.

[Cadair]

This will need careful API deprecation ☹️

[wtbarnes]

What's the best way to go about this? Do we support an extra kwarg (top_right???) and ignore width and height if top_right is given?

[wtbarnes]

Or do we add a new method altogether with this new syntax and then add a deprecation warning to draw_rectangle?

[Cadair]

What's the best way to go about this? Do we support an extra kwarg (top_right???) and ignore width and height if top_right is given?

I was thinking this one.

I quite like the name draw_rectangle so I don't really know what I would call the new one.

[Raahul-Singh]

So, from what i get, we need to add a parameter top_right and use it and bottom_left to figure out height and width as plt.Rectangle works with height and width ?

[nabobalis]

I assume we would want to unify the API for both functions using submap API's.

[Raahul-Singh]

In other words, create the rectangle as is done in submap and use the same for draw_rectangle?

[nabobalis]

Yeah but raise warnings if they use the old keywords that they will be removed in future.

[Raahul-Singh]

Looking at the checks that my PR is failing, I think I'd need some assistance in cleaning this up. 😅

[nabobalis]

Please try to keep PR problems to the PR and not the original issue.

[Raahul-Singh]

Ok. Will keep that in mind 👍
May I delete the original comment?