summaryrefslogtreecommitdiff
path: root/bignum.c
diff options
context:
space:
mode:
authornagachika <nagachika@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2013-03-09 13:52:22 +0000
committernagachika <nagachika@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2013-03-09 13:52:22 +0000
commit9fcf2f8f4b64d9badf3d0c35f9913ad897cf4394 (patch)
treedc20dfcbd50500405b0aa0eb0a225a5a8ff00782 /bignum.c
parentfa4e355e578afdd71bf45d51b3d6802d687287fd (diff)
merge revision(s) 39418:
* 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/branches/ruby_2_0_0@39666 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'bignum.c')
-rw-r--r--bignum.c8
1 files changed, 5 insertions, 3 deletions
diff --git a/bignum.c b/bignum.c
index 8601d80342..54dd75cf89 100644
--- a/bignum.c
+++ b/bignum.c
@@ -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.
*
*/