Mirrors/bevy
2
0
Fork 0
mirror of https://github.com/bevyengine/bevy synced 2024-12-20 18:13:10 +00:00
Code Issues Projects Releases Packages Wiki Activity

Fix atan2 docs (#16673)

Browse source 
# Objective

The parameter names for `bevy::math::ops::atan2` are labelled such that
`x` is the first argument and `y` is the second argument, but it passes
those arguments directly to
[`f32::atan2`](https://doc.rust-lang.org/stable/std/primitive.f32.html#method.atan2),
whose parameters are expected to be `(y, x)`. This PR changes the
parameter names in the bevy documentation to use the correct order for
the operation being performed. You can verify this by doing:

```rust
fn main() {
    let x = 3.0;
    let y = 4.0;
    let angle = bevy::math::ops::atan2(x, y);
    // standard polar coordinates formula
    dbg!(5.0 * angle.cos(), 5.0 * angle.sin());
}
```

This will print `(4.0, 3.0)`, which has flipped `x` and `y`. The problem
is that the `atan2` function to calculate the angle was really expecting
`(y, x)`, not `(x, y)`.

## Solution

I flipped the parameter names for `bevy::math::ops::atan2` and updated
the documentation. I also removed references to `self` and `other` from
the documentation which seemed to be copied from the `f32::atan2`
documentation.

## Testing

Not really needed, you can compare the `f32::atan2` docs to the
`bevy::math::ops::atan2` docs to see the problem is obvious. If a test
is required I could add a short one.
## Migration Guide

I'm not sure if this counts as a breaking change, since the
implementation clearly meant to use `f32::atan2` directly, so it was
really just the parameter names that were wrong.
This commit is contained in:
Daniel Beckwith 2024-12-09 22:19:05 -05:00 committed by GitHub
parent f6668cdf9f
commit 488f64d700
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
crates/bevy_math/src/ops.rs
View file

@ -143,7 +143,7 @@ mod std_ops {
f32::atan(x) f32::atan(x)
} }
/// Computes the four quadrant arctangent of `self` (`y`) and `other` (`x`) in radians. /// Computes the four-quadrant arctangent of `y` and `x` in radians.
/// ///
/// * `x = 0`, `y = 0`: `0` /// * `x = 0`, `y = 0`: `0`
/// * `x >= 0`: `arctan(y/x)` -> `[-pi/2, pi/2]` /// * `x >= 0`: `arctan(y/x)` -> `[-pi/2, pi/2]`
@ -152,8 +152,8 @@ mod std_ops {
/// ///
/// Precision is specified when the `libm` feature is enabled. /// Precision is specified when the `libm` feature is enabled.
#[inline(always)] #[inline(always)]
pub fn atan2(x: f32, y: f32) -> f32 { pub fn atan2(y: f32, x: f32) -> f32 {
f32::atan2(x, y) f32::atan2(y, x)
} }
/// Simultaneously computes the sine and cosine of the number, `x`. Returns /// Simultaneously computes the sine and cosine of the number, `x`. Returns
@ -358,7 +358,7 @@ mod libm_ops {
libm::atanf(x) libm::atanf(x)
} }
/// Computes the four quadrant arctangent of `self` (`y`) and `other` (`x`) in radians. /// Computes the four-quadrant arctangent of `y` and `x` in radians.
/// ///
/// * `x = 0`, `y = 0`: `0` /// * `x = 0`, `y = 0`: `0`
/// * `x >= 0`: `arctan(y/x)` -> `[-pi/2, pi/2]` /// * `x >= 0`: `arctan(y/x)` -> `[-pi/2, pi/2]`
@ -367,8 +367,8 @@ mod libm_ops {
/// ///
/// Precision is specified when the `libm` feature is enabled. /// Precision is specified when the `libm` feature is enabled.
#[inline(always)] #[inline(always)]
pub fn atan2(x: f32, y: f32) -> f32 { pub fn atan2(y: f32, x: f32) -> f32 {
libm::atan2f(x, y) libm::atan2f(y, x)
} }
/// Simultaneously computes the sine and cosine of the number, `x`. Returns /// Simultaneously computes the sine and cosine of the number, `x`. Returns