Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Update documentation for render :file. References #2858.

git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@3015 5ecf4fe2-1ee6-0310-87b1-e25e094e27de
  • Loading branch information...
commit 5cd2f3269731c151581fbb4b3a32df18409a84dc 1 parent da2d4d6
@jeremy jeremy authored
Showing with 14 additions and 8 deletions.
  1. +2 −0  actionpack/CHANGELOG
  2. +12 −8 actionpack/lib/action_controller/base.rb
View
2  actionpack/CHANGELOG
@@ -1,5 +1,7 @@
*SVN*
+* Update documentation for render :file. #2858 [Tom Werner]
+
* Only include builtin filters whose filenames match /^[a-z][a-z_]*_helper.rb$/ to avoid including operating system metadata such as ._foo_helper.rb. #2855 [court3nay@gmail.com]
* Added FormHelper#form_for and FormHelper#fields_for that makes it easier to work with forms for single objects also if they don't reside in instance variables [DHH]. Examples:
View
20 actionpack/lib/action_controller/base.rb
@@ -460,8 +460,7 @@ def controller_name
end
protected
- # Renders the content that'll be returned to the browser as the response body. This can just be as regular text, but is
- # more often the compilation of a template.
+ # Renders the content that will be returned to the browser as the response body.
#
# === Rendering an action
#
@@ -521,14 +520,19 @@ def controller_name
#
# === Rendering a file
#
- # File rendering works just like action rendering except that it takes an absolute path.
- # The current layout is not applied automatically.
+ # File rendering works just like action rendering except that it takes a filesystem path. By default, the path
+ # is assumed to be absolute, and the current layout is not applied.
#
- # # Renders the template located in /path/to/some/template.r(html|xml)
- # render :file => "/path/to/some/template"
+ # # Renders the template located at the absolute filesystem path
+ # render :file => "/path/to/some/template.rhtml"
+ # render :file => "c:/path/to/some/template.rhtml"
#
- # # Renders the same template within the current layout, but with a 404 status code
- # render :file => "/path/to/some/template", :layout => true, :status => 404
+ # # Renders a template within the current layout, and with a 404 status code
+ # render :file => "/path/to/some/template.rhtml", :layout => true, :status => 404
+ # render :file => "c:/path/to/some/template.rhtml", :layout => true, :status => 404
+ #
+ # # Renders a template relative to the template root and chooses the proper file extension
+ # render :file => "some/template", :use_full_path => true
#
# _Deprecation_ _notice_: This used to have the signature <tt>render_file(path, status = 200)</tt>
#
Please sign in to comment.
Something went wrong with that request. Please try again.