From 66bcd6db94edbbc410a0bb628677ad258024f8a9 Mon Sep 17 00:00:00 2001 From: Benjamin Paul Date: Fri, 9 Feb 2024 18:57:48 +1000 Subject: [PATCH] Clarify parity values returned by perm_parity function --- src/cube333/cubiecube.rs | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/cube333/cubiecube.rs b/src/cube333/cubiecube.rs index 4d074e0..a0ef4aa 100644 --- 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() }