From 9a2220e018adedcdcd7e4589deac1b8eb99f4f87 Mon Sep 17 00:00:00 2001
From: Ludwig-Uni <ludwig.kolesch@student.uni-tuebingen.de>
Date: Thu, 1 Jun 2023 23:24:49 +0200
Subject: [PATCH] Add missing docstring to VariableCombination.CompareTo

---
 LazyMathInstructor/Program.cs | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/LazyMathInstructor/Program.cs b/LazyMathInstructor/Program.cs
index 812f190..d8ceed1 100644
--- 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)