From 7efd912ab7668fe042d84109c44d548231f3a437 Mon Sep 17 00:00:00 2001
From: Vincent <v4zhong@uwaterloo.ca>
Date: Mon, 23 Dec 2024 20:48:02 -0500
Subject: [PATCH] Fix GenericComparator documentation

Updated doc for GenericComparator
#760
---
 src/include/storage/index/generic_key.h | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/src/include/storage/index/generic_key.h b/src/include/storage/index/generic_key.h
index a20f5bbac..9f3e201a3 100644
--- a/src/include/storage/index/generic_key.h
+++ b/src/include/storage/index/generic_key.h
@@ -71,7 +71,11 @@ class GenericKey {
 };
 
 /**
- * Function object returns true if lhs < rhs, used for trees
+ * Function object returns:
+ *  < 0 if lhs < rhs
+ *  > 0 if lhs > rhs
+ *  = 0 if lhs = rhs
+ * Used for tree comparisons.
  */
 template <size_t KeySize>
 class GenericComparator {