* lib/yaml.rb: documentation updates, patched by zzak.

  [ruby-core:54735] [Backport #8356]


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

1 files changed, 40 insertions, 12 deletions

diff --git a/lib/yaml.rb b/lib/yaml.rb
index ff9e1a6344..3461f68606 100644
--- a/lib/yaml.rb
+++ b/lib/yaml.rb
@@ -1,18 +1,46 @@
-##
-# The YAML module allows you to use one of the two YAML engines that ship with
-# ruby.  By default Psych is used but the old and unmaintained Syck may be
-# chosen.
+# YAML Ain't Markup Language
 #
-# See Psych or Syck for usage and documentation.
+# This module provides a Ruby interface for data serialization in YAML format.
 #
-# To set the YAML engine to syck:
+# You can choose from one of two YAML engines that ship with Ruby 1.9. By
+# default Psych is used but the old unmaintained Syck may chosen.
 #
-#   YAML::ENGINE.yamler = 'syck'
+# == Usage
+#
+# 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"
+#
+# == Security
+#
+# Do not use YAML to load untrusted data. Doing so is unsafe and could allow
+# malicious input to execute arbitrary code inside your application. Please see
+# doc/security.rdoc for more information.
+#
+# == Syck
 #
-# To set the YAML engine back to psych:
+# Syck was the original for YAML implementation in Ruby's standard library
+# developed by why the lucky stiff.
 #
+# If you prefer, you can still use Syck by changing the YAML::ENGINE like so:
+#
+#   YAML::ENGINE.yamler = 'syck'
+#   # switch back to the default Psych
 #   YAML::ENGINE.yamler = 'psych'
-
+#
+# In older Ruby versions, ie. <= 1.9, Syck is still provided, however it was
+# completely removed with the release of Ruby 2.0.0.
+#
+# == More info
+#
+# For more advanced details on the implementation see Psych, and also check out
+# http://yaml.org for spec details and other helpful information.
 module YAML
   class EngineManager # :nodoc:
     attr_reader :yamler
@@ -45,7 +73,7 @@ module YAML
   ##
   # Allows changing the current YAML engine.  See YAML for details.
 
-  ENGINE = YAML::EngineManager.new
+  ENGINE = YAML::EngineManager.new # :nodoc:
 end
 
 if defined?(Psych)
@@ -65,11 +93,11 @@ else
   end
 end
 
-module Syck
+module Syck # :nodoc:
   ENGINE = YAML::ENGINE
 end
 
-module Psych
+module Psych # :nodoc:
   ENGINE = YAML::ENGINE
 end