aboutsummaryrefslogtreecommitdiffstats
path: root/actionpack/lib/action_controller/base.rb
diff options
context:
space:
mode:
authorMichael Koziarski <michael@koziarski.com>2007-10-15 07:04:10 +0000
committerMichael Koziarski <michael@koziarski.com>2007-10-15 07:04:10 +0000
commitfe234a1538dd96c6e0d3ca44b651fcc7abc4663e (patch)
tree0e73892be0c99976f1e1b4d65902e4118b6ec185 /actionpack/lib/action_controller/base.rb
parent3353b85b0eae76bf36ae7c2f7b6adc1863278a8e (diff)
downloadrails-fe234a1538dd96c6e0d3ca44b651fcc7abc4663e.tar.gz
rails-fe234a1538dd96c6e0d3ca44b651fcc7abc4663e.tar.bz2
rails-fe234a1538dd96c6e0d3ca44b651fcc7abc4663e.zip
Fix Json related documentation for render and the AR serializer. Closes #9814. Closes #9833. [chuyeow]
git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@7905 5ecf4fe2-1ee6-0310-87b1-e25e094e27de
Diffstat (limited to 'actionpack/lib/action_controller/base.rb')
-rwxr-xr-xactionpack/lib/action_controller/base.rb16
1 files changed, 11 insertions, 5 deletions
diff --git a/actionpack/lib/action_controller/base.rb b/actionpack/lib/action_controller/base.rb
index 0f5604c707..b1fdea4635 100755
--- a/actionpack/lib/action_controller/base.rb
+++ b/actionpack/lib/action_controller/base.rb
@@ -748,16 +748,22 @@ module ActionController #:nodoc:
#
# === Rendering JSON
#
- # Rendering JSON sets the content type to text/x-json and optionally wraps the JSON in a callback. It is expected
- # that the response will be eval'd for use as a data structure.
+ # Rendering JSON sets the content type to application/json and optionally wraps the JSON in a callback. It is expected
+ # that the response will be parsed (or eval'd) for use as a data structure.
#
- # # Renders '{name: "David"}'
+ # # Renders '{"name": "David"}'
# render :json => {:name => "David"}.to_json
#
+ # It's not necessary to call <tt>to_json</tt> on the object you want to render, since <tt>render</tt> will
+ # automatically do that for you:
+ #
+ # # Also renders '{"name": "David"}'
+ # render :json => {:name => "David"}
+ #
# Sometimes the result isn't handled directly by a script (such as when the request comes from a SCRIPT tag),
- # so the callback option is provided for these cases.
+ # so the <tt>:callback</tt> option is provided for these cases.
#
- # # Renders 'show({name: "David"})'
+ # # Renders 'show({"name": "David"})'
# render :json => {:name => "David"}.to_json, :callback => 'show'
#
# === Rendering an inline template