Update crates/bevy_math/src/aspect_ratio.rs

Co-authored-by: Gonçalo Rica Pais da Silva <bluefinger@gmail.com>
bevyengine · Sep 8, 2024 · 5e7ba86 · 5e7ba86
1 parent e789b31
commit 5e7ba86
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/crates/bevy_math/src/aspect_ratio.rs b/crates/bevy_math/src/aspect_ratio.rs
@@ -26,6 +26,10 @@ impl AspectRatio {
  pub const ULTRAWIDE: Self = Self(21.0 / 9.0);
 
  /// Create a new [`AspectRatio`] from a given width and height.
+ ///
+ /// # Panics
+ /// Panics when the width and height values are invalid, such a zero or infinite widths/heights, or if either
+ /// value is `NaN`.
  #[inline]
  pub fn new(width: f32, height: f32) -> Self {
  Self::try_new(width, height).expect("Invalid aspect ratio")