* lib/yaml.rb: Documentation for YAML module [Bug #8213]

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@40499 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

1 files changed, 24 insertions, 1 deletions

diff --git a/lib/yaml.rb b/lib/yaml.rb
index 93e869cd79..76657cdd0b 100644
--- a/lib/yaml.rb
+++ b/lib/yaml.rb
@@ -12,7 +12,7 @@ rescue LoadError
   raise
 end
 
-module Psych
+module Psych # :nodoc:
   class EngineManager
     # Returns the YAML engine in use.
     #
@@ -53,4 +53,27 @@ module Psych
   ENGINE = EngineManager.new # :nodoc:
 end
 
+# YAML Ain't Markup Language
+#
+# This module provides a Ruby interface for data serialization in YAML format.
+#
+# The underlying implementation depends on an engine to handle the parsing and
+# serialization for Ruby, by default this will be using the libyaml wrapper
+# Psych.
+#
+# See Psych::EngineManager for details on switching the default YAML engine.
+#
+# Working with YAML can be very simple, for example:
+#
+#     require 'yaml' # STEP ONE, REQUIRE YAML!
+#     # Parse a YAML string
+#     YAML.load("--- foo") #=> "foo"
+#
+#     # Emit some YAML
+#     YAML.dump("foo")     # => "--- foo\n...\n"
+#     { :a => 'b'}.to_yaml  # => "---\n:a: b\n"
+#
+# For more advanced details on the implementation see Psych, and also check out
+# yaml.org for spec details and other helpful information.
+module YAML; end
 YAML = Psych