Skip to content
This repository
Browse code

Escape 'caching' when used in a sentence; remove unnessesary quotes

  • Loading branch information...
commit 930102968ab9bfe3998228dcb809acb46d5a1fc6 1 parent d3bc970
Joost Baaij authored August 26, 2010
4  actionpack/lib/action_controller/caching.rb
@@ -3,7 +3,7 @@
3 3
 require 'set'
4 4
 
5 5
 module ActionController #:nodoc:
6  
-  # Caching is a cheap way of speeding up slow applications by keeping the result of
  6
+  # \Caching is a cheap way of speeding up slow applications by keeping the result of
7 7
   # calculations, renderings, and database calls around for subsequent requests.
8 8
   # Action Controller affords you three approaches in varying levels of granularity:
9 9
   # Page, Action, Fragment.
@@ -14,7 +14,7 @@ module ActionController #:nodoc:
14 14
   # Note: To turn off all caching and sweeping, set
15 15
   #   config.action_controller.perform_caching = false.
16 16
   #
17  
-  # == Caching stores
  17
+  # == \Caching stores
18 18
   #
19 19
   # All the caching stores from ActiveSupport::Cache are available to be used as backends
20 20
   # for Action Controller caching. This setting only affects action and fragment caching
14  actionpack/lib/action_controller/caching/actions.rb
@@ -23,15 +23,15 @@ module Caching
23 23
     # Action caching internally uses the fragment caching and an around
24 24
     # filter to do the job. The fragment cache is named according to both
25 25
     # the current host and the path. So a page that is accessed at
26  
-    # http://david.somewhere.com/lists/show/1 will result in a fragment named
27  
-    # "david.somewhere.com/lists/show/1". This allows the cacher to
28  
-    # differentiate between "david.somewhere.com/lists/" and
29  
-    # "jamis.somewhere.com/lists/" -- which is a helpful way of assisting
  26
+    # <tt>http://david.example.com/lists/show/1</tt> will result in a fragment named
  27
+    # <tt>david.example.com/lists/show/1</tt>. This allows the cacher to
  28
+    # differentiate between <tt>david.example.com/lists/</tt> and
  29
+    # <tt>jamis.example.com/lists/</tt> -- which is a helpful way of assisting
30 30
     # the subdomain-as-account-key pattern.
31 31
     #
32 32
     # Different representations of the same resource, e.g.
33  
-    # <tt>http://david.somewhere.com/lists</tt> and
34  
-    # <tt>http://david.somewhere.com/lists.xml</tt>
  33
+    # <tt>http://david.example.com/lists</tt> and
  34
+    # <tt>http://david.example.com/lists.xml</tt>
35 35
     # are treated like separate requests and so are cached separately.
36 36
     # Keep in mind when expiring an action cache that
37 37
     # <tt>:action => 'lists'</tt> is not the same as
@@ -144,7 +144,7 @@ class ActionCachePath
144 144
         attr_reader :path, :extension
145 145
 
146 146
         # If +infer_extension+ is true, the cache path extension is looked up from the request's
147  
-        # path & format. This is desirable when reading and writing the cache, but not when
  147
+        # path and format. This is desirable when reading and writing the cache, but not when
148 148
         # expiring the cache - expire_action should expire the same files regardless of the
149 149
         # request format.
150 150
         def initialize(controller, options = {}, infer_extension = true)
6  actionpack/lib/action_controller/caching/fragments.rb
@@ -18,7 +18,7 @@ module Caching
18 18
     #
19 19
     #   <% cache(:action => "list", :action_suffix => "all_topics") do %>
20 20
     #
21  
-    # That would result in a name such as "/topics/list/all_topics", avoiding conflicts with the action cache and with any fragments that use a
  21
+    # That would result in a name such as <tt>/topics/list/all_topics</tt>, avoiding conflicts with the action cache and with any fragments that use a
22 22
     # different suffix. Note that the URL doesn't have to really exist or be callable - the url_for system is just used to generate unique
23 23
     # cache names that we can refer to when we need to expire the cache.
24 24
     #
@@ -28,7 +28,7 @@ module Caching
28 28
     module Fragments
29 29
       # Given a key (as described in <tt>expire_fragment</tt>), returns a key suitable for use in reading,
30 30
       # writing, or expiring a cached fragment. If the key is a hash, the generated key is the return
31  
-      # value of url_for on that hash (without the protocol). All keys are prefixed with "views/" and uses
  31
+      # value of url_for on that hash (without the protocol). All keys are prefixed with <tt>views/</tt> and uses
32 32
       # ActiveSupport::Cache.expand_cache_key for the expansion.
33 33
       def fragment_cache_key(key)
34 34
         ActiveSupport::Cache.expand_cache_key(key.is_a?(Hash) ? url_for(key).split("://").last : key, :views)
@@ -71,7 +71,7 @@ def fragment_exist?(key, options = nil)
71 71
       #
72 72
       # +key+ can take one of three forms:
73 73
       # * String - This would normally take the form of a path, like
74  
-      #   <tt>"pages/45/notes"</tt>.
  74
+      #   <tt>pages/45/notes</tt>.
75 75
       # * Hash - Treated as an implicit call to +url_for+, like
76 76
       #   <tt>{:controller => "pages", :action => "notes", :id => 45}</tt>
77 77
       # * Regexp - Will remove any fragment that matches, so

0 notes on commit 9301029

Please sign in to comment.
Something went wrong with that request. Please try again.