From 821df55bea14036004f4cdabe06db9c84636ae4c Mon Sep 17 00:00:00 2001
From: "John T. Wodder II" <git@varonathe.org>
Date: Mon, 9 Dec 2024 07:41:58 -0500
Subject: [PATCH] Document `cmp_range()`

---
 src/cmp_range.rs | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/src/cmp_range.rs b/src/cmp_range.rs
index ca0f9f5..cd06f83 100644
--- a/src/cmp_range.rs
+++ b/src/cmp_range.rs
@@ -1,5 +1,10 @@
 use std::cmp::Ordering;
 
+/// Compares `value` to `lower` and `upper`, where `lower <= upper`, and
+/// reports on where `value` falls with respect to the range.
+///
+/// See [`RangeOrdering`] for the recognized possibilities.
+///
 /// # Panics
 ///
 /// Panics if `lower > upper`
@@ -19,13 +24,20 @@ pub fn cmp_range<T: Ord + std::fmt::Debug>(value: T, lower: T, upper: T) -> Rang
     }
 }
 
+/// Return type of [`cmp_range()`]
 #[derive(Clone, Copy, Debug, Hash, Eq, PartialEq)]
 pub enum RangeOrdering {
+    /// Returned when `value` is less than `lower`
     Less,
+    /// Returned when `value` equals `lower` and is less than `upper`
     EqLower,
+    /// Returned when `value` is between `lower` and `upper`
     Between,
+    /// Returned when `value` equals both `lower` and `upper`
     EqBoth,
+    /// Returned when `value` equals `upper` and is greater than `lower`
     EqUpper,
+    /// Returned when `value` is greater than `upper`
     Greater,
 }