1 files changed, 43 insertions, 0 deletions
diff --git a/lib/yaml/store.rb b/lib/yaml/store.rb
index a7f8a5657d..82d6ee1aaa 100644
--- a/lib/yaml/store.rb
+++ b/lib/yaml/store.rb
@@ -4,7 +4,48 @@
 require 'yaml'
 require 'pstore'
 
+# YAML::Store provides the same functionality as PStore, except it uses YAML
+# to dump objects instead of Marshal.
+#
+# == Example
+#
+#   require 'yaml/store'
+#
+#   Person = Struct.new :first_name, :last_name
+#
+#   people = [Person.new("Bob", "Smith"), Person.new("Mary", "Johnson")]
+#
+#   store = YAML::Store.new "test.store"
+#
+#   store.transaction do
+#     store["people"] = people
+#     store["greeting"] = { "hello" => "world" }
+#   end
+#
+# After running the above code, the contents of "test.store" will be:
+#
+#   ---
+#   people:
+#   - !ruby/struct:Person
+#     first_name: Bob
+#     last_name: Smith
+#   - !ruby/struct:Person
+#     first_name: Mary
+#     last_name: Johnson
+#   greeting:
+#     hello: world
+
 class YAML::Store < PStore
+
+  # :call-seq:
+  #   initialize( file_name, yaml_opts = {} )
+  #
+  # Creates a new YAML::Store object, which will store data in +file_name+.
+  # If the file does not already exist, it will be created.
+  #
+  #
+  # Options passed in through +yaml_opts+ will be used when converting the
+  # store to YAML via Hash#to_yaml().
   def initialize( *o )
     @opt = {}
     if String === o.first
@@ -15,6 +56,8 @@ class YAML::Store < PStore
     end
   end
 
+  # :stopdoc:
+
   def dump(table)
     @table.to_yaml(@opt)
   end