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

Mention of Vec normalization for Dir::new #13483

Merged
merged 1 commit into from
May 23, 2024
Merged

Mention of Vec normalization for Dir::new #13483

merged 1 commit into from
May 23, 2024

Conversation

bugsweeper
Copy link
Contributor

@bugsweeper bugsweeper commented May 23, 2024 •
edited
Loading

Objective

Solution

  • Improved docs for methods new, new_and_length of Dir2, Dir3, Dir3A.

mweatherley
mweatherley suggested changes May 23, 2024
View reviewed changes
crates/bevy_math/src/direction.rs Outdated
@@ -118,7 +118,8 @@ impl Dir2 {
Self(value)
}

/// Create a direction from a finite, nonzero [`Vec2`], also returning its original length.
/// Create a direction from a finite, nonzero [`Vec2`], normalizing it,
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
/// Create a direction from a finite, nonzero [`Vec2`], normalizing it,
/// Create a direction from a finite, nonzero [`Vec2`], normalizing it and

@mweatherley mweatherley added C-Docs An addition or correction to our documentation D-Trivial Nice and easy! A great choice to get started with Bevy A-Math Fundamental domain-agnostic mathematical operations X-Uncontroversial This work is generally agreed upon labels May 23, 2024
@mweatherley mweatherley 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 May 23, 2024
@alice-i-cecile alice-i-cecile added this pull request to the merge queue May 23, 2024
Merged via the queue into bevyengine:main with commit da1e6e6 May 23, 2024
28 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bushrat011899 bushrat011899 bushrat011899 approved these changes

@mweatherley mweatherley mweatherley approved these changes

@13ros27 13ros27 13ros27 approved these changes

@Jondolf Jondolf Jondolf approved these changes

Assignees
No one assigned
Labels
A-Math Fundamental domain-agnostic mathematical operations C-Docs An addition or correction to our documentation D-Trivial Nice and easy! A great choice to get started with Bevy S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it X-Uncontroversial This work is generally agreed upon
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

DirX::new should be more explicit about normalization and have a code example
6 participants
@bugsweeper @bushrat011899 @mweatherley @13ros27 @Jondolf @alice-i-cecile