summaryrefslogtreecommitdiff
path: root/string.c
diff options
context:
space:
mode:
authorBurdetteLamar <burdettelamar@yahoo.com>2025-12-20 22:22:35 +0000
committerPeter Zhu <peter@peterzhu.ca>2025-12-20 18:13:08 -0500
commitaddbeb6cf337695647db6e265b5db87105d1c2e9 (patch)
tree9d3d8410ef6e6c705ec9e96220884e6a5744d548 /string.c
parent7c1e37cfe13cf2df21e4ca23c91f5a53c81bc062 (diff)
[DOC] Note for String#<=> about Comparable
Diffstat (limited to 'string.c')
-rw-r--r--string.c3
1 files changed, 3 insertions, 0 deletions
diff --git a/string.c b/string.c
index 83219d1a26..8c7c82c10f 100644
--- a/string.c
+++ b/string.c
@@ -4315,6 +4315,9 @@ rb_str_eql(VALUE str1, VALUE str2)
* 'ab' <=> 'a' # => 1
* 'a' <=> :a # => nil
*
+ * \Class \String includes module Comparable,
+ * each of whose methods uses String#<=> for comparison.
+ *
* Related: see {Comparing}[rdoc-ref:String@Comparing].
*/