Skip to content
Browse files

Merge pull request #5018 from hammerdr/issue-4659-docs

Adding documentation to clarify usage of attributes hash.
  • Loading branch information...
2 parents 804135b + a3a1a6f commit 9bcfb1a9745d5fafbbd95f78df0819f2e842d2d4 @tenderlove tenderlove committed Feb 13, 2012
Showing with 7 additions and 4 deletions.
  1. +7 −4 activemodel/lib/active_model/serialization.rb
View
11 activemodel/lib/active_model/serialization.rb
@@ -17,7 +17,7 @@ module ActiveModel
# attr_accessor :name
#
# def attributes
- # {'name' => name}
+ # {'name' => nil}
# end
#
# end
@@ -29,8 +29,11 @@ module ActiveModel
# person.name = "Bob"
# person.serializable_hash # => {"name"=>"Bob"}
#
- # You need to declare some sort of attributes hash which contains the attributes
- # you want to serialize and their current value.
+ # You need to declare an attributes hash which contains the attributes
+ # you want to serialize. When called, serializable hash will use
+ # instance methods that match the name of the attributes hash's keys.
+ # In order to override this behavior, take a look at the private
+ # method read_attribute_for_serialization.
#
# Most of the time though, you will want to include the JSON or XML
# serializations. Both of these modules automatically include the
@@ -47,7 +50,7 @@ module ActiveModel
# attr_accessor :name
#
# def attributes
- # {'name' => name}
+ # {'name' => nil}
# end
#
# end

0 comments on commit 9bcfb1a

Please sign in to comment.
Something went wrong with that request. Please try again.