Skip to content
Browse files

Revised documentation for cache_helper.

  • Loading branch information...
1 parent 890105f commit 5fb2f0c07f0e30adc2b3a6d2a1fab896ee9739b8 @rizwanreza rizwanreza committed Dec 23, 2010
Showing with 10 additions and 12 deletions.
  1. +10 −12 actionpack/lib/action_view/helpers/cache_helper.rb
View
22 actionpack/lib/action_view/helpers/cache_helper.rb
@@ -2,31 +2,29 @@ module ActionView
# = Action View Cache Helper
module Helpers
module CacheHelper
- # This helper to exposes a method for caching of view fragments.
- # See ActionController::Caching::Fragments for usage instructions.
+ # This helper exposes a method for caching view fragments caching
+ # fragments of a view rather than an entire action or page. This
+ # technique is useful caching pieces like menus, lists of news
+ # topics, static HTML fragments, and so on. This method takes a
+ # block that contains the content you wish to cache.
#
- # A method for caching fragments of a view rather than an entire
- # action or page. This technique is useful caching pieces like
- # menus, lists of news topics, static HTML fragments, and so on.
- # This method takes a block that contains the content you wish
- # to cache. See ActionController::Caching::Fragments for more
- # information.
+ # See ActionController::Caching::Fragments for usage instructions.
#
# ==== Examples
- # If you wanted to cache a navigation menu, you could do the
- # following.
+ # If you want to cache a navigation menu, you can do following:
#
# <% cache do %>
# <%= render :partial => "menu" %>
# <% end %>
#
- # You can also cache static content...
+ # You can also cache static content:
#
# <% cache do %>
# <p>Hello users! Welcome to our website!</p>
# <% end %>
#
- # ...and static content mixed with RHTML content.
+ # Static content with embedded ruby content can be cached as
+ # well:
#
# <% cache do %>
# Topics:

0 comments on commit 5fb2f0c

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