From d089ee8639970127a617f902989a3eb3bbadf4c3 Mon Sep 17 00:00:00 2001
From: Oscar Del Ben <info@oscardelben.com>
Date: Wed, 25 Apr 2012 12:00:19 +0200
Subject: Add include documentation to serialization

---
 activemodel/lib/active_model/serialization.rb | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

(limited to 'activemodel/lib/active_model')

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 ||= {}
-- 
cgit v1.2.3