summaryrefslogtreecommitdiff
path: root/numeric.rb
diff options
context:
space:
mode:
authorMatheus Richard <matheusrichardt@gmail.com>2021-12-14 14:12:37 -0300
committerGitHub <noreply@github.com>2021-12-15 02:12:37 +0900
commitb8f7fc361d2cf2266e39e97c57bba6edd6c6edaf (patch)
treee1ad72f761b95480daa4f1c7be8ca352f4512cee /numeric.rb
parentb32b755ea2446d67fd53b89b68080ad9b66ac68d (diff)
Add examples for Integer.try_convert [ci skip]
Notes
Notes: Merged: https://github.com/ruby/ruby/pull/5268 Merged-By: nobu <nobu@ruby-lang.org>
Diffstat (limited to 'numeric.rb')
-rw-r--r--numeric.rb3
1 files changed, 3 insertions, 0 deletions
diff --git a/numeric.rb b/numeric.rb
index eea1ac96cd..9f2200d2a8 100644
--- a/numeric.rb
+++ b/numeric.rb
@@ -233,11 +233,14 @@ end
# Integer.try_convert(object) -> object, integer, or nil
#
# If +object+ is an \Integer object, returns +object+.
+# Integer.try_convert(1) # => 1
#
# Otherwise if +object+ responds to <tt>:to_int</tt>,
# calls <tt>object.to_int</tt> and returns the result.
+# Integer.try_convert(1.25) # => 1
#
# Returns +nil+ if +object+ does not respond to <tt>:to_int</tt>
+# Integer.try_convert([]) # => nil
#
# Raises an exception unless <tt>object.to_int</tt> returns an \Integer object.
#