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.

Sign up for GitHub

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

Jump to bottom

Rename RayTest to RayCast #11635

Merged
merged 2 commits into from
Feb 2, 2024
Merged

Rename RayTest to RayCast #11635

merged 2 commits into from
Feb 2, 2024

Conversation

NiseVoid
Copy link
Contributor

Objective

  • RayTest vs AabbCast and CircleCast is inconsistent

Solution

  • Renaming the other two would only make the name more confusing, so we rename RayTest2d/3d to RayCast2d/3d

@Jondolf Jondolf added C-Code-Quality A section of code that is hard to understand or change A-Math Fundamental domain-agnostic mathematical operations labels Jan 31, 2024
Jondolf
Jondolf approved these changes Jan 31, 2024
View reviewed changes
Copy link
Contributor

@Jondolf Jondolf left a comment •
edited
Loading

Choose a reason for hiding this comment

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

I think this change is reasonable. People might have some extra expectations for something called RayCast and not just bounding volume intersections, but the docs do mention it, the structs are in the bounding module to begin with, and the consistency in naming is valuable.

@matiqo15 matiqo15 added the M-Needs-Migration-Guide A breaking change to Bevy's public API that needs to be noted in a migration guide label Feb 1, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Feb 1, 2024

It looks like your PR is a breaking change, but you didn't provide a migration guide.

Could you add some context on what users should update when this change get released in a new version of Bevy?
It will be used to help writing the migration guide for the version. Putting it after a ## Migration Guide will help it get automatically picked up by our tooling.

@matiqo15 matiqo15 added the S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it label Feb 1, 2024
@alice-i-cecile alice-i-cecile added this pull request to the merge queue Feb 2, 2024
Merged via the queue into bevyengine:main with commit 0ffc8d8 Feb 2, 2024
25 checks passed
tjamaan pushed a commit to tjamaan/bevy that referenced this pull request Feb 6, 2024
@NiseVoid @tjamaan
Rename RayTest to RayCast (bevyengine#11635)
aa91125 
# Objective

- `RayTest` vs `AabbCast` and `CircleCast` is inconsistent

## Solution

- Renaming the other two would only make the name more confusing, so we
rename `RayTest2d/3d` to `RayCast2d/3d`
@NiseVoid NiseVoid deleted the rename_raytest branch November 3, 2024 22:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@matiqo15 matiqo15 matiqo15 approved these changes

@Jondolf Jondolf Jondolf approved these changes

@NthTensor NthTensor NthTensor approved these changes

Assignees
No one assigned
Labels
A-Math Fundamental domain-agnostic mathematical operations C-Code-Quality A section of code that is hard to understand or change M-Needs-Migration-Guide A breaking change to Bevy's public API that needs to be noted in a migration guide 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
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@NiseVoid @NthTensor @Jondolf @matiqo15 @alice-i-cecile