From fe234a1538dd96c6e0d3ca44b651fcc7abc4663e Mon Sep 17 00:00:00 2001 From: Michael Koziarski Date: Mon, 15 Oct 2007 07:04:10 +0000 Subject: 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 --- actionpack/lib/action_controller/base.rb | 16 +++++++++++----- actionpack/lib/action_controller/mime_type.rb | 2 +- 2 files changed, 12 insertions(+), 6 deletions(-) (limited to 'actionpack/lib/action_controller') 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 to_json on the object you want to render, since render 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 :callback 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 diff --git a/actionpack/lib/action_controller/mime_type.rb b/actionpack/lib/action_controller/mime_type.rb index ef5fee0864..a0e2e70deb 100644 --- a/actionpack/lib/action_controller/mime_type.rb +++ b/actionpack/lib/action_controller/mime_type.rb @@ -52,7 +52,7 @@ module Mime EXTENSION_LOOKUP[extension] end - # Registers an alias that's not usd on mime type lookup, but can be referenced directly. Especially useful for + # Registers an alias that's not used on mime type lookup, but can be referenced directly. Especially useful for # rendering different HTML versions depending on the user agent, like an iPhone. def register_alias(string, symbol, extension_synonyms = []) register(string, symbol, [], extension_synonyms, true) -- cgit v1.2.3