aboutsummaryrefslogtreecommitdiffstats
path: root/actionpack/lib/action_controller/metal/strong_parameters.rb
diff options
context:
space:
mode:
authorLinus Marton <linus.pettersson@gmail.com>2018-05-18 10:03:42 +0200
committerLinus Marton <linus.pettersson@gmail.com>2018-05-18 10:03:42 +0200
commit8d5e0d3f5b9a81efbea2db42de70f0b34eed6e31 (patch)
treee6018c96fd8bdff24bd1024f93721a0490d23030 /actionpack/lib/action_controller/metal/strong_parameters.rb
parent9f95767979579f5761cb0d2bcccb67f3662349c5 (diff)
downloadrails-8d5e0d3f5b9a81efbea2db42de70f0b34eed6e31.tar.gz
rails-8d5e0d3f5b9a81efbea2db42de70f0b34eed6e31.tar.bz2
rails-8d5e0d3f5b9a81efbea2db42de70f0b34eed6e31.zip
Fix documentation for ActionController::Params#fetch
Make it clear that the return value is converted to an instance of ActionController::Parameters if possible
Diffstat (limited to 'actionpack/lib/action_controller/metal/strong_parameters.rb')
-rw-r--r--actionpack/lib/action_controller/metal/strong_parameters.rb4
1 files changed, 3 insertions, 1 deletions
diff --git a/actionpack/lib/action_controller/metal/strong_parameters.rb b/actionpack/lib/action_controller/metal/strong_parameters.rb
index 5a06bf86e3..46c0e80194 100644
--- a/actionpack/lib/action_controller/metal/strong_parameters.rb
+++ b/actionpack/lib/action_controller/metal/strong_parameters.rb
@@ -560,12 +560,14 @@ module ActionController
# Returns a parameter for the given +key+. If the +key+
# can't be found, there are several options: With no other arguments,
# it will raise an <tt>ActionController::ParameterMissing</tt> error;
- # if more arguments are given, then that will be returned; if a block
+ # if a second argument is given, then that is returned (converted to an
+ # instance of ActionController::Parameters if possible); if a block
# is given, then that will be run and its result returned.
#
# params = ActionController::Parameters.new(person: { name: "Francesco" })
# params.fetch(:person) # => <ActionController::Parameters {"name"=>"Francesco"} permitted: false>
# params.fetch(:none) # => ActionController::ParameterMissing: param is missing or the value is empty: none
+ # params.fetch(:none, {}) # => <ActionController::Parameters {} permitted: false>
# params.fetch(:none, "Francesco") # => "Francesco"
# params.fetch(:none) { "Francesco" } # => "Francesco"
def fetch(key, *args)