aboutsummaryrefslogtreecommitdiffstats
path: root/actionview
diff options
context:
space:
mode:
authorRafael Mendonça França <rafaelmfranca@gmail.com>2016-07-17 03:49:35 -0300
committerRafael Mendonça França <rafaelmfranca@gmail.com>2016-07-17 03:49:56 -0300
commitb0770523e184118d61310565ea5b7802f3f2db71 (patch)
treef4806d9b9a539ca7f7e19b763997baae1f495eea /actionview
parent81b6bc99754e33f31d4ed61306680ae2c6f68045 (diff)
parent80ac40c6d4a674b6c5fa16bfa5cb5f95e89c3094 (diff)
downloadrails-b0770523e184118d61310565ea5b7802f3f2db71.tar.gz
rails-b0770523e184118d61310565ea5b7802f3f2db71.tar.bz2
rails-b0770523e184118d61310565ea5b7802f3f2db71.zip
Merge pull request #25850 from ojab/layout_doc_fix
Mention that layout can call a Proc [ci skip]
Diffstat (limited to 'actionview')
-rw-r--r--actionview/lib/action_view/layouts.rb5
1 files changed, 4 insertions, 1 deletions
diff --git a/actionview/lib/action_view/layouts.rb b/actionview/lib/action_view/layouts.rb
index a74a5e05f3..8db1674187 100644
--- a/actionview/lib/action_view/layouts.rb
+++ b/actionview/lib/action_view/layouts.rb
@@ -248,11 +248,14 @@ module ActionView
#
# If the specified layout is a:
# String:: the String is the template name
- # Symbol:: call the method specified by the symbol, which will return the template name
+ # Symbol:: call the method specified by the symbol
+ # Proc:: call the passed Proc
# false:: There is no layout
# true:: raise an ArgumentError
# nil:: Force default layout behavior with inheritance
#
+ # Return value of Proc & Symbol arguments should be String, false, true or nil
+ # with the same meaning as described above.
# ==== Parameters
# * <tt>layout</tt> - The layout to use.
#