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

Rename bevy_math::rects conversion methods #9159

Merged
merged 1 commit into from
Jul 15, 2023
Merged

Conversation

RCoder01
Copy link
Contributor

@RCoder01 RCoder01 commented Jul 14, 2023

Objective

Some of the conversion methods on the new rect types introduced in #7984 have misleading names.

Solution

Rename all methods returning an IRect to as_irect and all methods returning a URect to as_urect.

Migration Guide

Replace Rect::as_urect with Rect::as_irect, Rect::as_rect with Rect::as_urect, and URect::as_urect with URect::as_irect.

@github-actions
Copy link
Contributor

Welcome, new contributor!

Please make sure you've read our contributing guide and we look forward to reviewing your pull request shortly ✨

@RCoder01
Copy link
Contributor Author

RCoder01 commented Jul 14, 2023

Does anything need to be done to ensure this (possibly breaking) change applies to 0.12 and not 0.11.1?

@Selene-Amanita Selene-Amanita added C-Code-Quality A section of code that is hard to understand or change A-Math Fundamental domain-agnostic mathematical operations labels Jul 15, 2023
@Selene-Amanita
Copy link
Member

Selene-Amanita commented Jul 15, 2023

Does anything need to be done to ensure this (possibly breaking) change applies to 0.12 and not 0.11.1?

I think commits are just cherry-picked from the main branch to apply to the 0.11.0 commit, so nothing special to do.

Also, I think a breaking change on an API introduced in 0.11.0 may be fine??? Really not sure about that probably not, it does break semver.

@Selene-Amanita Selene-Amanita added S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it C-Breaking-Change A breaking change to Bevy's public API that needs to be noted in a migration guide labels Jul 15, 2023
@james7132 james7132 added this to the 0.12 milestone Jul 15, 2023
Copy link
Member

@james7132 james7132 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you please update the Migration guide to be a bit more exact? As it currently stands, it's not particularly useful for someone trying to follow the guide.

@james7132 james7132 added this pull request to the merge queue Jul 15, 2023
Merged via the queue into bevyengine:main with commit 94b574a Jul 15, 2023
25 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Math Fundamental domain-agnostic mathematical operations C-Breaking-Change A breaking change to Bevy's public API that needs to be noted in a migration guide C-Code-Quality A section of code that is hard to understand or change S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants