Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

improve serialization doc

  • Loading branch information...
commit e34a4014ad2bf1d52c934f06093d179f469c62ac 1 parent 93bcb0c
Oscar Del Ben oscardelben authored
Showing with 5 additions and 4 deletions.
  1. +5 −4 activemodel/lib/active_model/serialization.rb
9 activemodel/lib/active_model/serialization.rb
View
@@ -26,17 +26,18 @@ module ActiveModel
# person.serializable_hash # => {"name"=>"Bob"}
#
# You need to declare an attributes hash which contains the attributes
- # you want to serialize. When called, serializable hash will use
+ # you want to serialize. Attributes must be strings, not symbols.
+ # 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.
+ # 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
- # ActiveModel::Serialization module, so there is no need to explicitly
+ # ++ActiveModel::Serialization++ module, so there is no need to explicitly
# include it.
#
- # So a minimal implementation including XML and JSON would be:
+ # A minimal implementation including XML and JSON would be:
#
# class Person
# include ActiveModel::Serializers::JSON
Please sign in to comment.
Something went wrong with that request. Please try again.