From ced2b25036f9456212dc8d980d2c43b20f0dce2c Mon Sep 17 00:00:00 2001
From: Vijay Dev <vijaydev.cse@gmail.com>
Date: Sat, 4 Jun 2011 02:11:43 +0530
Subject: use clearer variable name in examples

---
 activemodel/lib/active_model/serializers/json.rb | 20 ++++++++++----------
 activemodel/lib/active_model/serializers/xml.rb  |  4 ++--
 2 files changed, 12 insertions(+), 12 deletions(-)

(limited to 'activemodel')

diff --git a/activemodel/lib/active_model/serializers/json.rb b/activemodel/lib/active_model/serializers/json.rb
index 0bfbf2aa06..0405705b35 100644
--- a/activemodel/lib/active_model/serializers/json.rb
+++ b/activemodel/lib/active_model/serializers/json.rb
@@ -22,13 +22,13 @@ module ActiveModel
       # of +as_json+. If true (the default) +as_json+ will emit a single root
       # node named after the object's type. For example:
       #
-      #   konata = User.find(1)
-      #   konata.as_json
+      #   user = User.find(1)
+      #   user.as_json
       #   # => { "user": {"id": 1, "name": "Konata Izumi", "age": 16,
       #                   "created_at": "2006/08/01", "awesome": true} }
       #
       #   ActiveRecord::Base.include_root_in_json = false
-      #   konata.as_json
+      #   user.as_json
       #   # => {"id": 1, "name": "Konata Izumi", "age": 16,
       #         "created_at": "2006/08/01", "awesome": true}
       #
@@ -38,30 +38,30 @@ module ActiveModel
       # Without any +options+, the returned JSON string will include all the model's
       # attributes. For example:
       #
-      #   konata = User.find(1)
-      #   konata.as_json
+      #   user = User.find(1)
+      #   user.as_json
       #   # => {"id": 1, "name": "Konata Izumi", "age": 16,
       #         "created_at": "2006/08/01", "awesome": true}
       #
       # The <tt>:only</tt> and <tt>:except</tt> options can be used to limit the attributes
       # included, and work similar to the +attributes+ method. For example:
       #
-      #   konata.as_json(:only => [ :id, :name ])
+      #   user.as_json(:only => [ :id, :name ])
       #   # => {"id": 1, "name": "Konata Izumi"}
       #
-      #   konata.as_json(:except => [ :id, :created_at, :age ])
+      #   user.as_json(:except => [ :id, :created_at, :age ])
       #   # => {"name": "Konata Izumi", "awesome": true}
       #
       # To include the result of some method calls on the model use <tt>:methods</tt>:
       #
-      #   konata.as_json(:methods => :permalink)
+      #   user.as_json(:methods => :permalink)
       #   # => {"id": 1, "name": "Konata Izumi", "age": 16,
       #         "created_at": "2006/08/01", "awesome": true,
       #         "permalink": "1-konata-izumi"}
       #
       # To include associations use <tt>:include</tt>:
       #
-      #   konata.as_json(:include => :posts)
+      #   user.as_json(:include => :posts)
       #   # => {"id": 1, "name": "Konata Izumi", "age": 16,
       #         "created_at": "2006/08/01", "awesome": true,
       #         "posts": [{"id": 1, "author_id": 1, "title": "Welcome to the weblog"},
@@ -69,7 +69,7 @@ module ActiveModel
       #
       # Second level and higher order associations work as well:
       #
-      #   konata.as_json(:include => { :posts => {
+      #   user.as_json(:include => { :posts => {
       #                                  :include => { :comments => {
       #                                                :only => :body } },
       #                                  :only => :title } })
diff --git a/activemodel/lib/active_model/serializers/xml.rb b/activemodel/lib/active_model/serializers/xml.rb
index f6aae24324..9812af43d6 100644
--- a/activemodel/lib/active_model/serializers/xml.rb
+++ b/activemodel/lib/active_model/serializers/xml.rb
@@ -139,8 +139,8 @@ module ActiveModel
       # Without any +options+, the returned XML string will include all the model's
       # attributes. For example:
       #
-      #   konata = User.find(1)
-      #   konata.to_xml
+      #   user = User.find(1)
+      #   user.to_xml
       #
       #   <?xml version="1.0" encoding="UTF-8"?>
       #   <user>
-- 
cgit v1.2.3