diff options
| author | Oscar Del Ben <info@oscardelben.com> | 2012-04-25 12:00:19 +0200 |
|---|---|---|
| committer | Oscar Del Ben <info@oscardelben.com> | 2012-04-25 12:00:19 +0200 |
| commit | d089ee8639970127a617f902989a3eb3bbadf4c3 (patch) | |
| tree | f5e2f0cd84a8fce2e6928999ebf44e241a94745e /activemodel | |
| parent | e34a4014ad2bf1d52c934f06093d179f469c62ac (diff) | |
| download | rails-d089ee8639970127a617f902989a3eb3bbadf4c3.tar.gz rails-d089ee8639970127a617f902989a3eb3bbadf4c3.tar.bz2 rails-d089ee8639970127a617f902989a3eb3bbadf4c3.zip | |
Add include documentation to serialization
Diffstat (limited to 'activemodel')
| -rw-r--r-- | activemodel/lib/active_model/serialization.rb | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/activemodel/lib/active_model/serialization.rb b/activemodel/lib/active_model/serialization.rb index d0bd8bab15..214b03e0fb 100644 --- a/activemodel/lib/active_model/serialization.rb +++ b/activemodel/lib/active_model/serialization.rb @@ -64,7 +64,12 @@ module ActiveModel # person.to_json # => "{\"name\":\"Bob\"}" # person.to_xml # => "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<serial-person... # - # Valid options are <tt>:only</tt>, <tt>:except</tt> and <tt>:methods</tt> . + # Valid options are <tt>:only</tt>, <tt>:except</tt>, <tt>:methods</tt> and <tt>include</tt>. + # The following are all valid examples: + # + # person.serializable_hash(:only => 'name') + # person.serializable_hash(:include => :address) + # person.serializable_hash(:include => { :address => { :only => 'city' }}) module Serialization def serializable_hash(options = nil) options ||= {} |