Document the ordering of None vs Some in Option

chromium · Dec 11, 2023 · 5f32eca · 5f32eca
1 parent 0c08f72
commit 5f32eca
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/sus/option/option.h b/sus/option/option.h
@@ -1731,7 +1731,8 @@ class Option final {
   friend constexpr inline bool operator==(const Option<T>& l,
                                           const Option<U>& r) = delete;
 
-  /// Compares two options.
+  /// Compares two options. This function requires that `T` is ordered.
+  /// An empty Option always compares less than a non-empty Option.
   ///
   /// * Satisfies [`StrongOrd<Option<T>>`]($sus::cmp::StrongOrd) if
   ///   [`StrongOrd<T>`]($sus::cmp::StrongOrd).