aboutsummaryrefslogtreecommitdiffstats
path: root/actionpack/lib/action_view/renderer/renderer.rb
diff options
context:
space:
mode:
authorRafael Mendonça França <rafaelmfranca@gmail.com>2013-04-19 10:31:59 -0700
committerRafael Mendonça França <rafaelmfranca@gmail.com>2013-04-19 10:31:59 -0700
commitfc5090c937db4d3795aa97d9130747ab6a1de8b0 (patch)
treee92a0a73136ca7dbd5efd638abe143a4c39b9c9c /actionpack/lib/action_view/renderer/renderer.rb
parenteaec0ec71f00f76f47811fc2f27761c7a73056b9 (diff)
parente8aceae5dba8ce067972c85e153ba7aeefd69342 (diff)
downloadrails-fc5090c937db4d3795aa97d9130747ab6a1de8b0.tar.gz
rails-fc5090c937db4d3795aa97d9130747ab6a1de8b0.tar.bz2
rails-fc5090c937db4d3795aa97d9130747ab6a1de8b0.zip
Merge pull request #10265 from wangjohn/documenting_actionview
Adding documentation to Renderer
Diffstat (limited to 'actionpack/lib/action_view/renderer/renderer.rb')
-rw-r--r--actionpack/lib/action_view/renderer/renderer.rb6
1 files changed, 6 insertions, 0 deletions
diff --git a/actionpack/lib/action_view/renderer/renderer.rb b/actionpack/lib/action_view/renderer/renderer.rb
index 30a0c4be70..964b18337e 100644
--- a/actionpack/lib/action_view/renderer/renderer.rb
+++ b/actionpack/lib/action_view/renderer/renderer.rb
@@ -2,6 +2,12 @@ module ActionView
# This is the main entry point for rendering. It basically delegates
# to other objects like TemplateRenderer and PartialRenderer which
# actually renders the template.
+ #
+ # The Renderer will parse the options from the +render+ or +render_body+
+ # method and render a partial or a template based on the options. The
+ # +TemplateRenderer+ and +PartialRenderer+ objects are wrappers which do all
+ # the setup and logic necessary to render a view and a new object is created
+ # each time +render+ is called.
class Renderer
attr_accessor :lookup_context