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 /bignum.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 'bignum.c')
-rw-r--r-- | bignum.c | 8 |
1 files changed, 5 insertions, 3 deletions
@@ -1520,9 +1520,11 @@ rb_integer_float_eq(VALUE x, VALUE y) * call-seq: * big <=> numeric -> -1, 0, +1 or nil * - * Comparison---Returns -1, 0, or +1 depending on whether <i>big</i> is - * less than, equal to, or greater than <i>numeric</i>. This is the - * basis for the tests in <code>Comparable</code>. + * Comparison---Returns -1, 0, or +1 depending on whether +big+ is + * less than, equal to, or greater than +numeric+. This is the + * basis for the tests in Comparable. + * + * +nil+ is returned if the two values are incomparable. * */ |