From 201ec1dd7f7e100e7597347356e034e400b6a3da Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Pavel=20Ku=C4=8Dera?= <teni@zlin6.cz>
Date: Thu, 23 May 2024 09:50:21 +0200
Subject: [PATCH] Update inverse.rs - improved code doc try_inverse_mut

The "and leaves `self` untouched" part of the code doc was wrong. Self may be modified before early false return.
---
 src/linalg/inverse.rs | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/src/linalg/inverse.rs b/src/linalg/inverse.rs
index 0f6e6614..336509a4 100644
--- a/src/linalg/inverse.rs
+++ b/src/linalg/inverse.rs
@@ -29,8 +29,8 @@ impl<T: ComplexField, D: Dim, S: Storage<T, D, D>> SquareMatrix<T, D, S> {
 }
 
 impl<T: ComplexField, D: Dim, S: StorageMut<T, D, D>> SquareMatrix<T, D, S> {
-    /// Attempts to invert this square matrix in-place. Returns `false` and leaves `self` untouched if
-    /// inversion fails.
+    /// Attempts to invert this square matrix in-place. Returns `false` if the
+    /// inversion fails. Note that `self` may be modified even if the inversion fails.
     ///
     /// # Panics
     ///