diff options
author | zzak <zzak@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2013-02-23 03:35:38 +0000 |
---|---|---|
committer | zzak <zzak@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2013-02-23 03:35:38 +0000 |
commit | c2204ca328817f3d87232471a4e1de0334425752 (patch) | |
tree | b5489d0f829a520280292240aba2dc834f99af4f /object.c | |
parent | 827e71bda54ffab6e2b2e0434b235c6190055cdb (diff) | |
download | ruby-c2204ca328817f3d87232471a4e1de0334425752.tar.gz |
* array.c: Document #<=> return values and formatting
* bignum.c: ditto
* file.c: ditto
* object.c: ditto
* numeric.c: ditto
* rational.c: ditto
* string.c: ditto
* time.c: ditto
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@39418 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'object.c')
-rw-r--r-- | object.c | 13 |
1 files changed, 7 insertions, 6 deletions
@@ -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 |