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

Deprecate radius kwarg for shapes #215

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

Conversation

raphaelquast
Copy link
Owner

@raphaelquast raphaelquast commented Dec 19, 2023

This PR deprecates the use of the "radius" and "radius_crs" kwargs of shapes in favor of "size" and "crs".

⚠️ Deprecations

  • The "radius" and "radius_crs" kwargs of m.set_shape.<SHAPE>(...) are deprecated in favor of "size" and "crs".

    • The main reason for this change is to unify kwargs for all shapes as the term "radius" is not intuitive, particularly for shapes such as rectangles etc.
    • ❗Using the old syntax will result in an error for in EOmaps > v8.5

    # Old syntax:
    m.set_shape.rectangles(radius=(3, 2), radius_crs=4326)
    m.set_shape.ellipses(radius=(3, 2), radius_crs=4326)
    # New syntax:
    m.set_shape.rectangles(size=(3, 2), crs=4326)
    m.set_shape.ellipses(size=(3, 2), crs=4326)

@raphaelquast raphaelquast changed the base branch from master to dev December 19, 2023 10:46
@raphaelquast raphaelquast added this to the EOmaps v8.0 milestone Dec 19, 2023
Copy link

codecov bot commented Dec 19, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (6d912c3) 76.19% compared to head (8b62114) 76.21%.

Additional details and impacted files
@@            Coverage Diff             @@
##              dev     #215      +/-   ##
==========================================
+ Coverage   76.19%   76.21%   +0.02%     
==========================================
  Files          23       23              
  Lines       11199    11209      +10     
==========================================
+ Hits         8533     8543      +10     
  Misses       2666     2666              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

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

Successfully merging this pull request may close these issues.

1 participant