Clarify parity values returned by perm_parity function

b-paul · Feb 9, 2024 · 66bcd6d · 66bcd6d
1 parent b16f477
commit 66bcd6d
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/src/cube333/cubiecube.rs b/src/cube333/cubiecube.rs
@@ -52,7 +52,8 @@ impl CubieCube {
         parity
     }
 
-    /// Return the permutation parity of the cube as a bool
+    /// Return the permutation parity of the cube as a bool. Returns true if there is parity, and
+    /// false if there is no parity.
     pub fn perm_parity(&self) -> bool {
         self.ep_parity() ^ self.cp_parity()
     }