diff options
author | nobu <nobu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2017-03-28 02:15:51 +0000 |
---|---|---|
committer | nobu <nobu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2017-03-28 02:15:51 +0000 |
commit | e014c8c4d84b570a9cb53f08d0348ab00d4b5505 (patch) | |
tree | 4ba06e9b6459f7472abc28cfde107a02acfa198f /numeric.c | |
parent | 47563655037ed453607de33b86fcc094878769ac (diff) |
numeric.c: improves Float#round rdoc [ci skip]
* numeric.c (flo_round): [DOC] improves Float#round documentation
to better highlight the half keyword. [Fix GH-1541]
Author: Evan Brodie <brodie.evan@gmail.com>
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@58190 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'numeric.c')
-rw-r--r-- | numeric.c | 11 |
1 files changed, 9 insertions, 2 deletions
@@ -2215,7 +2215,7 @@ rb_int_truncate(VALUE num, int ndigits) /* * call-seq: - * float.round([ndigits]) -> integer or float + * float.round([ndigits] [, half: symbol]) -> integer or float * * Rounds +float+ to a given precision in decimal digits (default 0 digits). * @@ -2242,13 +2242,20 @@ rb_int_truncate(VALUE num, int ndigits) * 34567.89.round(2) #=> 34567.89 * 34567.89.round(3) #=> 34567.89 * - * If <code>half:</code> optional keyword is given, just-half number + * If the <code>half:</code> optional keyword is given, just-half number * 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 + * + * 2.5.round(half: :up) #=> 3 + * 2.5.round(half: :even) #=> 2 + * 2.5.round(half: :down) #=> 2 + * 3.5.round(half: :up) #=> 4 + * 3.5.round(half: :even) #=> 4 + * 3.5.round(half: :down) #=> 3 */ static VALUE |