diff options
author | Daniel Schierbeck <daniel.schierbeck@gmail.com> | 2009-12-21 14:55:40 +0100 |
---|---|---|
committer | Daniel Schierbeck <daniel.schierbeck@gmail.com> | 2009-12-21 14:55:40 +0100 |
commit | d62661b46476181213a776819b19d4137b1441e8 (patch) | |
tree | 99611a9b536fca9ce1121ac60329e7102b91d15c /actionpack/lib/action_controller/metal/responder.rb | |
parent | 2094fe5bf425a7842f3492467abb4548ac8c5b9b (diff) | |
download | rails-d62661b46476181213a776819b19d4137b1441e8.tar.gz rails-d62661b46476181213a776819b19d4137b1441e8.tar.bz2 rails-d62661b46476181213a776819b19d4137b1441e8.zip |
Fix some typos in the docs for ActionController::Responder
Diffstat (limited to 'actionpack/lib/action_controller/metal/responder.rb')
-rw-r--r-- | actionpack/lib/action_controller/metal/responder.rb | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/actionpack/lib/action_controller/metal/responder.rb b/actionpack/lib/action_controller/metal/responder.rb index e8e88e7479..0c6f1cc96a 100644 --- a/actionpack/lib/action_controller/metal/responder.rb +++ b/actionpack/lib/action_controller/metal/responder.rb @@ -1,7 +1,7 @@ module ActionController #:nodoc: - # Responder is responsible to expose a resource for different mime requests, + # Responder is responsible for exposing a resource to different mime requests, # usually depending on the HTTP verb. The responder is triggered when - # respond_with is called. The simplest case to study is a GET request: + # <code>respond_with</code> is called. The simplest case to study is a GET request: # # class PeopleController < ApplicationController # respond_to :html, :xml, :json @@ -12,17 +12,17 @@ module ActionController #:nodoc: # end # end # - # When a request comes, for example with format :xml, three steps happen: + # When a request comes in, for example for an XML response, three steps happen: # - # 1) responder searches for a template at people/index.xml; + # 1) the responder searches for a template at people/index.xml; # - # 2) if the template is not available, it will invoke :to_xml in the given resource; + # 2) if the template is not available, it will invoke <code>#to_xml</code> on the given resource; # - # 3) if the responder does not respond_to :to_xml, call :to_format on it. + # 3) if the responder does not <code>respond_to :to_xml</code>, call <code>#to_format</code> on it. # # === Builtin HTTP verb semantics # - # Rails default responder holds semantics for each HTTP verb. Depending on the + # The default Rails responder holds semantics for each HTTP verb. Depending on the # content type, verb and the resource status, it will behave differently. # # Using Rails default responder, a POST request for creating an object could @@ -55,7 +55,7 @@ module ActionController #:nodoc: # # === Nested resources # - # You can given nested resource as you do in form_for and polymorphic_url. + # You can supply nested resources as you do in <code>form_for</code> and <code>polymorphic_url</code>. # Consider the project has many tasks example. The create action for # TasksController would be like: # @@ -67,7 +67,7 @@ module ActionController #:nodoc: # end # # Giving an array of resources, you ensure that the responder will redirect to - # project_task_url instead of task_url. + # <code>project_task_url</code> instead of <code>task_url</code>. # # Namespaced and singleton resources requires a symbol to be given, as in # polymorphic urls. If a project has one manager which has many tasks, it @@ -75,7 +75,7 @@ module ActionController #:nodoc: # # respond_with(@project, :manager, @task) # - # Check polymorphic_url documentation for more examples. + # Check <code>polymorphic_url</code> documentation for more examples. # class Responder attr_reader :controller, :request, :format, :resource, :resources, :options |