📚 Reformat search docs for SequenceSet coercion

This format simplifies updating the docs in later commits.
ruby · Nov 8, 2024 · 269afc9 · 269afc9
1 parent 5b1da5b
commit 269afc9
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/lib/net/imap.rb b/lib/net/imap.rb
@@ -1944,8 +1944,10 @@ def uid_expunge(uid_set)
     #
     # * When +criteria+ is an array, each member is a +SEARCH+ command argument:
     #   * Any SequenceSet sends SequenceSet#valid_string.
-    #     +Range+, <tt>-1</tt>, and nested +Array+ elements are converted to
-    #     SequenceSet.
+    #     These types are converted to SequenceSet for validation and encoding:
+    #     * +Range+
+    #     * <tt>-1</tt> translates to <tt>*</tt>
+    #     * nested +Array+
     #   * Any +String+ is sent verbatim when it is a valid \IMAP atom,
     #     and encoded as an \IMAP quoted or literal string otherwise.
     #   * Any other +Integer+ (besides <tt>-1</tt>) will be sent as +#to_s+.