From 11bcf952870630c41c2c21990d0935b639af532f Mon Sep 17 00:00:00 2001
From: schneems <richard.schneeman+foo@gmail.com>
Date: Thu, 30 Aug 2018 09:33:15 -0500
Subject: [ci skip] Document permitted_scalar_filter

---
 actionpack/lib/action_controller/metal/strong_parameters.rb | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/actionpack/lib/action_controller/metal/strong_parameters.rb b/actionpack/lib/action_controller/metal/strong_parameters.rb
index 52664dd1fb..21859e5356 100644
--- a/actionpack/lib/action_controller/metal/strong_parameters.rb
+++ b/actionpack/lib/action_controller/metal/strong_parameters.rb
@@ -904,6 +904,16 @@ module ActionController
         PERMITTED_SCALAR_TYPES.any? { |type| value.is_a?(type) }
       end
 
+      # Adds existing keys to the params if their values are scalar.
+      #
+      # For example:
+      #
+      #   puts self.keys #=> ["zipcode(90210i)"]
+      #   params = {}
+      #
+      #   permitted_scalar_filter(params, "zipcode")
+      #
+      #   puts params.keys # => ["zipcode"]
       def permitted_scalar_filter(params, key)
         if has_key?(key) && permitted_scalar?(self[key])
           params[key] = self[key]
-- 
cgit v1.2.3