aboutsummaryrefslogtreecommitdiffstats
path: root/numeric.c
diff options
context:
space:
mode:
authorakr <akr@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2016-12-21 05:26:35 +0000
committerakr <akr@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2016-12-21 05:26:35 +0000
commit46ba2d5bf49885cb0d0ca910a2b6b080b9cb21a8 (patch)
treecf211689141f1b3586a362e6a70b830a1609f176 /numeric.c
parent0fcfc7626fcf850a406aa7dffaf6e1ff66539d9d (diff)
downloadruby-46ba2d5bf49885cb0d0ca910a2b6b080b9cb21a8.tar.gz
[DOC] itemize values for half option of Float#round.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@57133 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'numeric.c')
-rw-r--r--numeric.c11
1 files changed, 6 insertions, 5 deletions
diff --git a/numeric.c b/numeric.c
index d68c54493f..3c380cb76b 100644
--- a/numeric.c
+++ b/numeric.c
@@ -2224,11 +2224,12 @@ rb_int_truncate(VALUE num, int ndigits)
* 34567.89.round(3) #=> 34567.89
*
* If <code>half:</code> optional keyword is given, just-half number
- * will be rounded according to that value. If it is
- * <code>:up</code> or +nil+, the result will be rounded up, or it is
- * <code>:even</code>, the result will be rounded to nearest even
- * number, or it is <code>:down</code>, the result will be rounded
- * down.
+ * will be rounded according to that value.
+ * Supported values for this keyword are follows.
+ *
+ * * <code>:up</code> or +nil+: the result will be rounded away from zero
+ * * <code>:even</code>: the result will be rounded to nearest even number
+ * * <code>:down</code>: the result will be rounded close to zero
*/
static VALUE