From 1eeaf3526ca3d6cde339cbb835c2d2f291df14b2 Mon Sep 17 00:00:00 2001 From: Christopher Durham Date: Mon, 5 Jul 2021 18:53:11 -0500 Subject: [PATCH] Rotation::matrix_mut_unchecked may not cause UB ...because it isn't unsafe, so clarify the documentation to match. --- src/geometry/rotation.rs | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/geometry/rotation.rs b/src/geometry/rotation.rs index f3127fb9..b894278b 100755 --- a/src/geometry/rotation.rs +++ b/src/geometry/rotation.rs @@ -199,9 +199,9 @@ impl Rotation { /// A mutable reference to the underlying matrix representation of this rotation. /// - /// This is suffixed by "_unchecked" because this allows the user to replace the matrix by another one that is - /// non-square, non-inversible, or non-orthonormal. If one of those properties is broken, - /// subsequent method calls may be UB. + /// This is suffixed by "_unchecked" because this allows the user to replace the + /// matrix by another one that is non-inversible or non-orthonormal. If one of + /// those properties is broken, subsequent method calls may return bogus results. #[inline] pub fn matrix_mut_unchecked(&mut self) -> &mut SMatrix { &mut self.matrix