Edits to caching/fragments.

1 files changed, 39 insertions, 17 deletions

diff --git a/actionpack/lib/action_controller/caching/fragments.rb b/actionpack/lib/action_controller/caching/fragments.rb
index 37c155b9cd..88f973e62d 100644
--- a/actionpack/lib/action_controller/caching/fragments.rb
+++ b/actionpack/lib/action_controller/caching/fragments.rb
@@ -1,40 +1,59 @@
 module ActionController #:nodoc:
   module Caching
-    # Fragment caching is used for caching various blocks within templates without caching the entire action as a whole. This is useful when
-    # certain elements of an action change frequently or depend on complicated state while other parts rarely change or can be shared amongst multiple
-    # parties. The caching is done using the cache helper available in the Action View. A template with caching might look something like:
+    # Fragment caching is used for caching various blocks within 
+    # views without caching the entire action as a whole. This is
+    # useful when certain elements of an action change frequently or 
+    # depend on complicated state while other parts rarely change or 
+    # can be shared amongst multiple parties. The caching is done using
+    # the <tt>cache</tt> helper available in the Action View. A 
+    # template with fragment caching might look like:
     #
     #   <b>Hello <%= @name %></b>
+    #
     #   <% cache do %>
     #     All the topics in the system:
     #     <%= render :partial => "topic", :collection => Topic.find(:all) %>
     #   <% end %>
     #
-    # This cache will bind to the name of the action that called it, so if this code was part of the view for the topics/list action, you would
-    # be able to invalidate it using <tt>expire_fragment(:controller => "topics", :action => "list")</tt>.
+    # This cache will bind the name of the action that called it, so if
+    # this code was part of the view for the topics/list action, you 
+    # would be able to invalidate it using:
+    #   
+    #   expire_fragment(:controller => "topics", :action => "list")
     #
-    # This default behavior is of limited use if you need to cache multiple fragments per action or if the action itself is cached using
-    # <tt>caches_action</tt>, so we also have the option to qualify the name of the cached fragment with something like:
+    # This default behavior is limited if you need to cache multiple 
+    # fragments per action or if the action itself is cached using 
+    # <tt>caches_action</tt>. To remedy this, there is an option to 
+    # qualify the name of the cached fragment by using the 
+    # <tt>:action_suffix</tt> option:
     #
     #   <% cache(:action => "list", :action_suffix => "all_topics") do %>
     #
-    # 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
-    # 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
-    # cache names that we can refer to when we need to expire the cache.
+    # 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 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 cache names
+    # that we can refer to when we need to expire the cache.
     #
     # The expiration call for this example is:
     #
-    #   expire_fragment(:controller => "topics", :action => "list", :action_suffix => "all_topics")
+    #   expire_fragment(:controller => "topics", 
+    #                   :action => "list", 
+    #                   :action_suffix => "all_topics")
     module Fragments
-      # Given a key (as described in <tt>expire_fragment</tt>), returns a key suitable for use in reading,
-      # writing, or expiring a cached fragment. If the key is a hash, the generated key is the return
-      # value of url_for on that hash (without the protocol). All keys are prefixed with <tt>views/</tt> and uses
+      # Given a key (as described in <tt>expire_fragment</tt>), returns
+      # a key suitable for use in reading, writing, or expiring a 
+      # cached fragment. If the key is a hash, the generated key is the
+      # return value of url_for on that hash (without the protocol). 
+      # All keys are prefixed with <tt>views/</tt> and uses
       # ActiveSupport::Cache.expand_cache_key for the expansion.
       def fragment_cache_key(key)
         ActiveSupport::Cache.expand_cache_key(key.is_a?(Hash) ? url_for(key).split("://").last : key, :views)
       end
 
-      # Writes <tt>content</tt> to the location signified by <tt>key</tt> (see <tt>expire_fragment</tt> for acceptable formats)
+      # Writes <tt>content</tt> to the location signified by 
+      # <tt>key</tt> (see <tt>expire_fragment</tt> for acceptable formats).
       def write_fragment(key, content, options = nil)
         return content unless cache_configured?
 
@@ -46,7 +65,8 @@ module ActionController #:nodoc:
         content
       end
 
-      # Reads a cached fragment from the location signified by <tt>key</tt> (see <tt>expire_fragment</tt> for acceptable formats)
+      # Reads a cached fragment from the location signified by <tt>key</tt>
+      # (see <tt>expire_fragment</tt> for acceptable formats).
       def read_fragment(key, options = nil)
         return unless cache_configured?
 
@@ -57,7 +77,8 @@ module ActionController #:nodoc:
         end
       end
 
-      # Check if a cached fragment from the location signified by <tt>key</tt> exists (see <tt>expire_fragment</tt> for acceptable formats)
+      # Check if a cached fragment from the location signified by 
+      # <tt>key</tt> exists (see <tt>expire_fragment</tt> for acceptable formats)
       def fragment_exist?(key, options = nil)
         return unless cache_configured?
         key = fragment_cache_key(key)
@@ -70,6 +91,7 @@ module ActionController #:nodoc:
       # Removes fragments from the cache.
       #
       # +key+ can take one of three forms:
+      #
       # * String - This would normally take the form of a path, like
       #   <tt>pages/45/notes</tt>.
       # * Hash - Treated as an implicit call to +url_for+, like