Permalink
Browse files

An updated description of Object#try to better reflect changes docume…

…nted at http://is.gd/hdmo and http://is.gd/hdmQ

Signed-off-by: Pratik Naik <pratiknaik@gmail.com>
  • Loading branch information...
1 parent c9b8a26 commit 6df580a0a8fe9c5df2353e5b435590a9a1cab3de Christos Zisopoulos committed with lifo Jan 26, 2009
Showing with 9 additions and 4 deletions.
  1. +9 −4 activesupport/lib/active_support/core_ext/try.rb
View
13 activesupport/lib/active_support/core_ext/try.rb
@@ -1,6 +1,9 @@
class Object
- # Tries to send the method only if object responds to it. Return +nil+ otherwise.
- # It will also forward any arguments and/or block like Object#send does.
+ # Invokes the method identified by +symbol+, passing it any arguments
+ # and/or the block specified, just like the regular Ruby <tt>Object#send</tt> does.
+ #
+ # *Unlike* that method however, a +NoMethodError+ exception will *not* be raised
+ # and +nil+ will be returned instead, if the receiving object is a +nil+ object or NilClass.
#
# ==== Examples
#
@@ -12,11 +15,13 @@ class Object
# With try
# @person.try(:name)
#
- # Try also accepts arguments/blocks for the method it is trying
+ # +try+ also accepts arguments and/or a block, for the method it is trying
# Person.try(:find, 1)
# @people.try(:collect) {|p| p.name}
#--
- # This method def is for rdoc only. The alias_method below overrides it as an optimization.
+ # This method definition below is for rdoc purposes only. The alias_method call
+ # below overrides it as an optimization since +try+ behaves like +Object#send+,
+ # unless called on +NilClass+.
def try(method, *args, &block)
send(method, *args, &block)
end

0 comments on commit 6df580a

Please sign in to comment.