From 2aa08e313d3cc3562a3651977c428f7ca9182810 Mon Sep 17 00:00:00 2001 From: Francesco Rodriguez Date: Mon, 7 Jan 2013 16:18:06 -0500 Subject: improve StrongParameters documentation [ci skip] --- .../lib/action_controller/metal/strong_parameters.rb | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) (limited to 'actionpack/lib') diff --git a/actionpack/lib/action_controller/metal/strong_parameters.rb b/actionpack/lib/action_controller/metal/strong_parameters.rb index a158e6dbae..5ea1b2cc1a 100644 --- a/actionpack/lib/action_controller/metal/strong_parameters.rb +++ b/actionpack/lib/action_controller/metal/strong_parameters.rb @@ -25,9 +25,9 @@ module ActionController # params.permit(:c) # # => ActionController::UnpermittedParameters: found unpermitted keys: a, b class UnpermittedParameters < IndexError - attr_reader :params + attr_reader :params # :nodoc: - def initialize(params) + def initialize(params) # :nodoc: @params = params super("found unpermitted keys: #{params.join(", ")}") end @@ -60,12 +60,11 @@ module ActionController # It provides two options that controls the top-level behavior of new instances: # # * +permit_all_parameters+ - If it's +true+, all the parameters will be - # permitted by default. The default value for +permit_all_parameters+ - # option is +false+. - # * +raise_on_unpermitted_parameters+ - If it's +true+, it will raise an exception - # if parameters that are not explicitly permitted are found. The default value for - # +raise_on_unpermitted_parameters+ # option is +true+ in test and development - # environments, +false+ otherwise. + # permitted by default. The default is +false+. + # * +raise_on_unpermitted_parameters+ - If it's +true+, it will raise an + # ActionController::UnpermittedParameters exception if parameters that are not + # explicitly permitted are found. The default value is +true+ in test and + # development environments, +false+ otherwise. # # params = ActionController::Parameters.new # params.permitted? # => false -- cgit v1.2.3