aboutsummaryrefslogtreecommitdiffstats
path: root/object.c
diff options
context:
space:
mode:
Diffstat (limited to 'object.c')
-rw-r--r--object.c13
1 files changed, 7 insertions, 6 deletions
diff --git a/object.c b/object.c
index 76ff316543..3da19cdf3d 100644
--- a/object.c
+++ b/object.c
@@ -1540,13 +1540,14 @@ rb_mod_gt(VALUE mod, VALUE arg)
/*
* call-seq:
- * mod <=> other_mod -> -1, 0, +1, or nil
+ * module <=> other_module -> -1, 0, +1, or nil
*
- * Comparison---Returns -1 if <i>mod</i> includes <i>other_mod</i>, 0 if
- * <i>mod</i> is the same as <i>other_mod</i>, and +1 if <i>mod</i> is
- * included by <i>other_mod</i>. Returns <code>nil</code> if <i>mod</i>
- * has no relationship with <i>other_mod</i> or if <i>other_mod</i> is
- * not a module.
+ * Comparison---Returns -1, 0, +1 or nil depending on whether +module+
+ * includes +other_module+, they are the same, or if +module+ is included by
+ * +other_module+. This is the basis for the tests in Comparable.
+ *
+ * Returns +nil+ if +module+ has no relationship with +other_module+, if
+ * +other_module+ is not a module, or if the two values are incomparable.
*/
static VALUE