From d9c3edbeeede1a0881522acea613612593b1a053 Mon Sep 17 00:00:00 2001
From: Brendan Zabarauskas <bjzaba@yahoo.com.au>
Date: Tue, 4 Dec 2012 11:56:10 +1000
Subject: [PATCH] Add return value description to the doc comment of `inverse`

---
 src/mat.rs | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/src/mat.rs b/src/mat.rs
index c3b5bee..31a8835 100644
--- a/src/mat.rs
+++ b/src/mat.rs
@@ -80,6 +80,11 @@ pub trait Matrix<T,V>: Dimensional<V>, ToPtr<T>, Eq, Neg<self> {
     
     /**
      * Returns the inverse of the matrix
+     * 
+     * # Return value
+     *
+     * - `Some(m)` if the inversion was successful, where `m` is the inverted matrix
+     * - `None` if the inversion was unsuccessful (because the matrix was not invertable)
      */
     pure fn inverse(&self) -> Option<self>;