From 3d31f322517a0092398559a05dd7f978b1bad77b Mon Sep 17 00:00:00 2001
From: Maxim Zhiburt <zhiburt@gmail.com>
Date: Tue, 19 Jul 2022 15:19:36 +0300
Subject: [PATCH] update try_inverse doc comment

---
 src/linalg/inverse.rs | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/src/linalg/inverse.rs b/src/linalg/inverse.rs
index f07be14a..ad6f96b4 100644
--- a/src/linalg/inverse.rs
+++ b/src/linalg/inverse.rs
@@ -9,6 +9,10 @@ use crate::linalg::lu;
 
 impl<T: ComplexField, D: Dim, S: Storage<T, D, D>> SquareMatrix<T, D, S> {
     /// Attempts to invert this matrix.
+    /// 
+    /// # Panics
+    /// 
+    /// It's unable to invert a non-square matrix so it panics in such case.
     #[inline]
     #[must_use = "Did you mean to use try_inverse_mut()?"]
     pub fn try_inverse(self) -> Option<OMatrix<T, D, D>>
@@ -27,6 +31,10 @@ 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 matrix in-place. Returns `false` and leaves `self` untouched if
     /// inversion fails.
+    /// 
+    /// # Panics
+    /// 
+    /// It's unable to invert a non-square matrix so it panics in such case.
     #[inline]
     pub fn try_inverse_mut(&mut self) -> bool
     where