Add missing docstring to VariableCombination.CompareTo

Ludwig-Work · Jun 1, 2023 · 9a2220e · 9a2220e
1 parent bd1861b
commit 9a2220e
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/LazyMathInstructor/Program.cs b/LazyMathInstructor/Program.cs
@@ -119,6 +119,11 @@ public override string ToString()
             return result;
         }
 
+        /// <summary>
+        /// Compares two <see cref="VariableCombination"/>s to establish an ordering. 
+        /// Earlier letters and higher exponents are ordered before later letters and smaller exponents:
+        /// a^3 < a^2 < ab < b^2 < c
+        /// </summary>
         public int CompareTo(object obj)
         {
             if (obj is not VariableCombination other)