From ca36326706edc6cc2ceffa18d093ba799cc65caf Mon Sep 17 00:00:00 2001
From: Joost Baaij <joost@spacebabies.nl>
Date: Thu, 26 Aug 2010 22:32:40 +0200
Subject: cleanup of ActionController::Metal inline documentation

---
 actionpack/lib/action_controller/metal/conditional_get.rb | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

(limited to 'actionpack/lib/action_controller/metal/conditional_get.rb')

diff --git a/actionpack/lib/action_controller/metal/conditional_get.rb b/actionpack/lib/action_controller/metal/conditional_get.rb
index 61e7ece90d..797ad846f6 100644
--- a/actionpack/lib/action_controller/metal/conditional_get.rb
+++ b/actionpack/lib/action_controller/metal/conditional_get.rb
@@ -6,7 +6,7 @@ module ActionController
     include Head
 
     # Sets the etag, last_modified, or both on the response and renders a
-    # "304 Not Modified" response if the request is already fresh.
+    # <tt>304 Not Modified</tt> response if the request is already fresh.
     #
     # Parameters:
     # * <tt>:etag</tt>
@@ -21,7 +21,7 @@ module ActionController
     #   end
     #
     # This will render the show template if the request isn't sending a matching etag or
-    # If-Modified-Since header and just a "304 Not Modified" response if there's a match.
+    # If-Modified-Since header and just a <tt>304 Not Modified</tt> response if there's a match.
     #
     def fresh_when(options)
       options.assert_valid_keys(:etag, :last_modified, :public)
@@ -36,7 +36,7 @@ module ActionController
     # Sets the etag and/or last_modified on the response and checks it against
     # the client request. If the request doesn't match the options provided, the
     # request is considered stale and should be generated from scratch. Otherwise,
-    # it's fresh and we don't need to generate anything and a reply of "304 Not Modified" is sent.
+    # it's fresh and we don't need to generate anything and a reply of <tt>304 Not Modified</tt> is sent.
     #
     # Parameters:
     # * <tt>:etag</tt>
@@ -60,8 +60,8 @@ module ActionController
       !request.fresh?(response)
     end
 
-    # Sets a HTTP 1.1 Cache-Control header. Defaults to issuing a "private" instruction, so that
-    # intermediate caches shouldn't cache the response.
+    # Sets a HTTP 1.1 Cache-Control header. Defaults to issuing a <tt>private</tt> instruction, so that
+    # intermediate caches must not cache the response.
     #
     # Examples:
     #   expires_in 20.minutes
@@ -77,7 +77,7 @@ module ActionController
       response.cache_control[:extras] = options.map {|k,v| "#{k}=#{v}"}
     end
 
-    # Sets a HTTP 1.1 Cache-Control header of "no-cache" so no caching should occur by the browser or
+    # Sets a HTTP 1.1 Cache-Control header of <tt>no-cache</tt> so no caching should occur by the browser or
     # intermediate caches (like caching proxy servers).
     def expires_now #:doc:
       response.cache_control.replace(:no_cache => true)
-- 
cgit v1.2.3