Apply suggestions from review

Author: jnsiemer

src/integer/mat_z/arithmetic/sub.rs

@@ -110,7 +110,7 @@ impl Sub<&MatQ> for &MatZ {
     type Output = MatQ;
 
     /// Implements the [`Sub`] trait for two matrices.
-    /// Furthermore, it is available for any combination of [`MatZ`] and [`MatQ`].
+    /// [`Sub`] is implemented for any combination of owned and borrowed values.
     ///
     /// Parameters:
     /// - `other`: specifies the value to subtract from `self`
@@ -136,7 +136,7 @@ impl Sub<&MatQ> for &MatZ {
     fn sub(self, other: &MatQ) -> Self::Output {
         let new_self = MatQ::from(self);
 
-        other.sub_safe(&new_self).unwrap()
+        new_self.sub_safe(other).unwrap()
     }
 }
 

src/rational/mat_q/arithmetic/add.rs

@@ -86,7 +86,6 @@ impl Add for &MatQ {
     type Output = MatQ;
     /// Implements the [`Add`] trait for two [`MatQ`] values.
     /// [`Add`] is implemented for any combination of [`MatQ`] and borrowed [`MatQ`].
-    /// Furthermore, any combination of [`MatQ`] and [`MatZ`] elements can be added.
     ///
     /// Parameters:
     /// - `other`: specifies the value to add to `self`
@@ -95,19 +94,16 @@ impl Add for &MatQ {
     ///
     /// # Examples
     /// ```
-    /// use qfall_math::{rational::MatQ, integer::MatZ};
+    /// use qfall_math::rational::MatQ;
     /// use std::str::FromStr;
     ///
     /// let a = MatQ::from_str("[[1/2, 2/3, 3/4],[3/4, 4/5, 5/7]]").unwrap();
     /// let b = MatQ::from_str("[[1/4, 9/7, 3/7],[1, 0, 5]]").unwrap();
-    /// let c = MatZ::identity(2, 3);
     ///
     /// let d: MatQ = &a + &b;
-    /// let e: MatQ = a + b;
-    /// let f: MatQ = &d + e;
-    /// let g: MatQ = d + &f;
-    /// let h: MatQ = &f + &c;
-    /// let i: MatQ = f + c;
+    /// let e: MatQ = &a + b;
+    /// let f: MatQ = d + &e;
+    /// let g: MatQ = e + f;
     /// ```
     ///
     /// # Panics ...
@@ -120,7 +116,30 @@ impl Add for &MatQ {
 impl Add<&MatZ> for &MatQ {
     type Output = MatQ;
 
-    /// Documentation at [`MatQ::add`].
+    /// Implements the [`Add`] trait for two [`MatQ`] values.
+    /// [`Add`] is implemented for any combination of [`MatQ`] and [`MatZ`].
+    ///
+    /// Parameters:
+    /// - `other`: specifies the value to add to `self`
+    ///
+    /// Returns the sum of both numbers as a [`MatQ`].
+    ///
+    /// # Examples
+    /// ```
+    /// use qfall_math::{rational::MatQ, integer::MatZ};
+    /// use std::str::FromStr;
+    ///
+    /// let a = MatQ::from_str("[[1/2, 2/3, 3/4],[3/4, 4/5, 5/7]]").unwrap();
+    /// let b = MatZ::identity(2, 3);
+    ///
+    /// let d: MatQ = &a + &b;
+    /// let e: MatQ = a + &b;
+    /// let f: MatQ = &b + d;
+    /// let g: MatQ = b + f;
+    /// ```
+    ///
+    /// # Panics ...
+    /// - if the dimensions of both matrices mismatch.
     fn add(self, other: &MatZ) -> Self::Output {
         let other = MatQ::from(other);
 

src/rational/mat_q/arithmetic/sub.rs

@@ -22,7 +22,6 @@ impl Sub for &MatQ {
     type Output = MatQ;
     /// Implements the [`Sub`] trait for two matrices.
     /// [`Sub`] is implemented for any combination of [`MatQ`] and borrowed [`MatQ`].
-    /// Furthermore, it is available for any combination of [`MatZ`] and [`MatQ`].
     ///
     /// Parameters:
     /// - `other`: specifies the value to subtract from `self`
@@ -31,19 +30,16 @@ impl Sub for &MatQ {
     ///
     /// # Examples
     /// ```
-    /// use qfall_math::{rational::MatQ, integer::MatZ};
+    /// use qfall_math::rational::MatQ;
     /// use std::str::FromStr;
     ///
     /// let a: MatQ = MatQ::from_str("[[1/2, 2/3, 3/4],[3/4, 4/5, 5/7]]").unwrap();
     /// let b: MatQ = MatQ::from_str("[[1/4, 9/7, 3/7],[1, 0, 5]]").unwrap();
-    /// let c: MatZ = MatZ::identity(2, 3);
     ///
     /// let d: MatQ = &a - &b;
     /// let e: MatQ = a - b;
     /// let f: MatQ = &d - e;
     /// let g: MatQ = d - &f;
-    /// let h: MatQ = &f - &c;
-    /// let i: MatQ = f - c;
     /// ```
     ///
     /// # Panics ...
@@ -56,7 +52,30 @@ impl Sub for &MatQ {
 impl Sub<&MatZ> for &MatQ {
     type Output = MatQ;
 
-    /// Documentation at [`MatQ::sub`].
+    /// Implements the [`Sub`] trait for two matrices.
+    /// [`Sub`] is implemented for any combination of [`MatQ`] and [`MatZ`].
+    ///
+    /// Parameters:
+    /// - `other`: specifies the value to subtract from `self`
+    ///
+    /// Returns the result of the subtraction as a [`MatQ`].
+    ///
+    /// # Examples
+    /// ```
+    /// use qfall_math::{rational::MatQ, integer::MatZ};
+    /// use std::str::FromStr;
+    ///
+    /// let a: MatQ = MatQ::from_str("[[1/2, 2/3, 3/4],[3/4, 4/5, 5/7]]").unwrap();
+    /// let b: MatZ = MatZ::identity(2, 3);
+    ///
+    /// let d: MatQ = &a - &b;
+    /// let e: MatQ = a - &b;
+    /// let f: MatQ = &b - e;
+    /// let g: MatQ = b - f;
+    /// ```
+    ///
+    /// # Panics ...
+    /// - if the dimensions of both matrices mismatch.
     fn sub(self, other: &MatZ) -> Self::Output {
         let other = MatQ::from(other);