aboutsummaryrefslogtreecommitdiffstats
path: root/object.c
diff options
context:
space:
mode:
authorhsbt <hsbt@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2016-10-14 09:27:23 +0000
committerhsbt <hsbt@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2016-10-14 09:27:23 +0000
commitc4ca249090ba6b17a8d172e72632827e1e8e339b (patch)
tree54d928d4f744e998b677b674efe062c347fa6715 /object.c
parent94422735ff498349d98b29decb08c9989f927efe (diff)
downloadruby-c4ca249090ba6b17a8d172e72632827e1e8e339b.tar.gz
* object.c: Improve documentation for Integer conversion.
[ruby-core:71661][Bug #11736][ci skip] git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@56421 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'object.c')
-rw-r--r--object.c9
1 files changed, 6 insertions, 3 deletions
diff --git a/object.c b/object.c
index 451746150d..9769c1ee26 100644
--- a/object.c
+++ b/object.c
@@ -2968,11 +2968,14 @@ FUNC_MINIMIZED(static VALUE rb_f_float(VALUE obj, VALUE arg));
* Float(arg) -> float
*
* Returns <i>arg</i> converted to a float. Numeric types are converted
- * directly, the rest are converted using <i>arg</i>.to_f.
+ * directly, and with exception to string and nil the rest are converted using <i>arg</i>.to_f.
+ * Converting a <code>string</code> with invalid characters will result in a <code>ArgumentError</code>.
* Converting <code>nil</code> generates a <code>TypeError</code>.
*
- * Float(1) #=> 1.0
- * Float("123.456") #=> 123.456
+ * Float(1) #=> 1.0
+ * Float("123.456") #=> 123.456
+ * Float("123.0_badstring") #=> ArgumentError: invalid value for Float(): "123.0_badstring"
+ * Float(nil) #=> TypeError: can't convert nil into Float
*/
static VALUE