From 2beea3b249763edcb133c1b7078958ef14815812 Mon Sep 17 00:00:00 2001
From: Olek Janiszewski <olek.janiszewski@gmail.com>
Date: Thu, 7 Jul 2011 23:01:27 +0300
Subject: Documentation fixes for rendering partials

---
 .../lib/action_view/renderer/partial_renderer.rb   | 31 ++++++++--------------
 1 file changed, 11 insertions(+), 20 deletions(-)

diff --git a/actionpack/lib/action_view/renderer/partial_renderer.rb b/actionpack/lib/action_view/renderer/partial_renderer.rb
index a351fbc04f..c6098fc7e0 100644
--- a/actionpack/lib/action_view/renderer/partial_renderer.rb
+++ b/actionpack/lib/action_view/renderer/partial_renderer.rb
@@ -12,8 +12,7 @@ module ActionView
   #
   #  <%= render :partial => "account" %>
   #
-  # This would render "advertiser/_account.html.erb" and pass the instance variable @account in as a local variable
-  # +account+ to the template for display.
+  # This would render "advertiser/_account.html.erb".
   #
   # In another template for Advertiser#buy, we could have:
   #
@@ -28,32 +27,24 @@ module ActionView
   #
   # == The :as and :object options
   #
-  # By default <tt>ActionView::Partials::PartialRenderer</tt> has its object in a local variable with the same
-  # name as the template. So, given
+  # By default <tt>ActionView::Partials::PartialRenderer</tt> doesn't have any local variables.
+  # The <tt>:object</tt> option can be used to pass an object to the partial. For instance:
   #
-  #   <%= render :partial => "contract" %>
+  #   <%= render :partial => "account", :object => @buyer %>
   #
-  # within contract we'll get <tt>@contract</tt> in the local variable +contract+, as if we had written
+  # would provide the +@buyer+ object to the partial, available under the local variable +account+ and is
+  # equivalent to:
   #
-  #   <%= render :partial => "contract", :locals => { :contract  => @contract } %>
+  #   <%= render :partial => "account", :locals => { :account => @buyer } %>
   #
   # With the <tt>:as</tt> option we can specify a different name for said local variable. For example, if we
-  # wanted it to be +agreement+ instead of +contract+ we'd do:
-  #
-  #   <%= render :partial => "contract", :as => 'agreement' %>
-  #
-  # The <tt>:object</tt> option can be used to directly specify which object is rendered into the partial;
-  # useful when the template's object is elsewhere, in a different ivar or in a local variable for instance.
+  # wanted it to be +user+ instead of +account+ we'd do:
   #
-  # Revisiting a previous example we could have written this code:
+  #   <%= render :partial => "account", :object => @buyer, :as => 'user' %>
   #
-  #   <%= render :partial => "account", :object => @buyer %>
-  #
-  #   <% @advertisements.each do |ad| %>
-  #     <%= render :partial => "ad", :object => ad %>
-  #   <% end %>
+  # This is equivalent to
   #
-  # The <tt>:object</tt> and <tt>:as</tt> options can be used together.
+  #   <%= render :partial => "account", :locals => { :user => @buyer } %>
   #
   # == Rendering a collection of partials
   #
-- 
cgit v1.2.3