Improve Flash API docs [ci-skip]
This cross-links the `flash` method doc to the `Flash` and `FlashHash` class docs, and fixes a code snippet formatting issue.
This commit is contained in:
parent
2a5acb00cb
commit
75a9e1be75
|
@ -20,10 +20,11 @@ module ActionDispatch
|
|||
# end
|
||||
# end
|
||||
#
|
||||
# show.html.erb
|
||||
# <% if flash[:notice] %>
|
||||
# <div class="notice"><%= flash[:notice] %></div>
|
||||
# <% end %>
|
||||
# Then in +show.html.erb+:
|
||||
#
|
||||
# <% if flash[:notice] %>
|
||||
# <div class="notice"><%= flash[:notice] %></div>
|
||||
# <% end %>
|
||||
#
|
||||
# Since the +notice+ and +alert+ keys are a common idiom, convenience accessors are available:
|
||||
#
|
||||
|
@ -41,9 +42,9 @@ module ActionDispatch
|
|||
KEY = "action_dispatch.request.flash_hash"
|
||||
|
||||
module RequestMethods
|
||||
# Access the contents of the flash. Use <tt>flash["notice"]</tt> to
|
||||
# read a notice you put there or <tt>flash["notice"] = "hello"</tt>
|
||||
# to put a new one.
|
||||
# Access the contents of the flash. Returns a ActionDispatch::Flash::FlashHash.
|
||||
#
|
||||
# See ActionDispatch::Flash for example usage.
|
||||
def flash
|
||||
flash = flash_hash
|
||||
return flash if flash
|
||||
|
|
Loading…
Reference in New Issue