* bignum.c (rb_big_idiv): added rdoc.

nobu · nobu · commit 6da90f39c6a1 · 2009-09-04T08:06:12.000Z
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@24749 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
diff --git a/bignum.c b/bignum.c
@@ -2308,7 +2308,9 @@ rb_big_divide(VALUE x, VALUE y, ID op)
  *  call-seq:
  *     big / other     => Numeric
  *
- *  Divides big by other, returning the result.
+ * Performs division: the class of the resulting object depends on
+ * the class of <code>numeric</code> and on the magnitude of the
+ * result.
  */
 
 VALUE
@@ -2317,6 +2319,13 @@ rb_big_div(VALUE x, VALUE y)
     return rb_big_divide(x, y, '/');
 }
 
+/*
+ *  call-seq:
+ *     big.div(other)  => integer
+ *
+ * Performs integer division: returns integer value.
+ */
+
 VALUE
 rb_big_idiv(VALUE x, VALUE y)
 {
