From 2faaccf10a05e0deab3eec9703adea00126f7fbb Mon Sep 17 00:00:00 2001
From: Vern Paxson <vern@corelight.com>
Date: Thu, 18 Mar 2021 11:32:34 -0700
Subject: [PATCH] explain cmp_func default

---
 src/Val.h | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/src/Val.h b/src/Val.h
index 06a74085b5..4b5fe3f345 100644
--- a/src/Val.h
+++ b/src/Val.h
@@ -1522,7 +1522,10 @@ public:
 	/**
 	 * Returns a "vector of count" holding the indices of this
 	 * vector when sorted using the given (optional) comparison function.
-	 * @param cmp_func  Comparison function for vector elements.
+	 * @param cmp_func  Comparison function for vector elements.  If
+	 *                  nullptr, then the vector must be internally
+	 *                  of a numeric, and the usual '<' comparison
+	 *                  will be used.
 	 */
 	VectorValPtr Order(Func* cmp_func = nullptr);