diff options
author | Mark Thomson <nzl216@gmail.com> | 2012-03-13 02:16:38 -0500 |
---|---|---|
committer | Mark Thomson <nzl216@gmail.com> | 2012-03-13 02:16:38 -0500 |
commit | fb094acc56f3b351986db35ee217caa7242d4cde (patch) | |
tree | 71c6d27c570bdf5ebd34ad8f2b470dd74c467bad /actionpack/lib/action_controller | |
parent | 10e1ce4fb9a430c779eb31b767cabedc3e228b51 (diff) | |
download | rails-fb094acc56f3b351986db35ee217caa7242d4cde.tar.gz rails-fb094acc56f3b351986db35ee217caa7242d4cde.tar.bz2 rails-fb094acc56f3b351986db35ee217caa7242d4cde.zip |
Updated description of #retrieve_collector_from_mimes
Diffstat (limited to 'actionpack/lib/action_controller')
-rw-r--r-- | actionpack/lib/action_controller/metal/mime_responds.rb | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/actionpack/lib/action_controller/metal/mime_responds.rb b/actionpack/lib/action_controller/metal/mime_responds.rb index 800752975c..41809cf6a1 100644 --- a/actionpack/lib/action_controller/metal/mime_responds.rb +++ b/actionpack/lib/action_controller/metal/mime_responds.rb @@ -259,8 +259,12 @@ module ActionController #:nodoc: end end - # Collects mimes and return the response for the negotiated format. Returns - # nil if :not_acceptable was sent to the client. + # Returns a Collector object containing the appropriate mime-type response + # for the current request, based on the available responses defined by a block. + # In typical usage this is the block passed to +respond_with+ or +respond_to+. + # + # Sends :not_acceptable to the client and returns nil if no suitable format + # is available. # def retrieve_collector_from_mimes(mimes=nil, &block) #:nodoc: mimes ||= collect_mimes_from_class_level |