summaryrefslogtreecommitdiff
path: root/object.c
diff options
context:
space:
mode:
authornagachika <nagachika@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2016-11-11 16:06:11 +0000
committernagachika <nagachika@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2016-11-11 16:06:11 +0000
commit627eec87257d22022d0c67fad697be8daaafef5a (patch)
treef56907e293dcabfb18a7bff93d7eec7ca4f6fa8d /object.c
parent1f32d9f495f7ace063cf57fcd28192f65afb5611 (diff)
merge revision(s) 56421,56422: [Backport #11736]
* object.c: Improve documentation for Integer conversion. [ruby-core:71661][Bug #11736][ci skip] * object.c: Improve documentation for Float conversion. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/branches/ruby_2_3@56722 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 3c502d5c0f..58d9c23ea1 100644
--- a/object.c
+++ b/object.c
@@ -2943,11 +2943,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