diff options
| author | eregon <eregon@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2018-03-02 12:56:37 +0000 |
|---|---|---|
| committer | eregon <eregon@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2018-03-02 12:56:37 +0000 |
| commit | 6a792d0b735ea7a83e22e30da57a9fe8e0097b7e (patch) | |
| tree | 403ed1482603ac47c11bf86a2326f8e0a9de4941 /lib/yaml.rb | |
| parent | 1de78c5fd89e7da938b6f92200e851e119ea74b7 (diff) | |
| download | ruby-6a792d0b735ea7a83e22e30da57a9fe8e0097b7e.tar.gz | |
Clarify the documentation of the YAML module [Misc #14567]
Based on a patch from Victor Shepelev
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@62635 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'lib/yaml.rb')
| -rw-r--r-- | lib/yaml.rb | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/lib/yaml.rb b/lib/yaml.rb index aa0a1eb470..e47e0a7f9b 100644 --- a/lib/yaml.rb +++ b/lib/yaml.rb @@ -1,6 +1,4 @@ # frozen_string_literal: false -## -# The YAML module is an alias of Psych, the YAML engine for Ruby. begin require 'psych' @@ -17,7 +15,7 @@ YAML = Psych # :nodoc: # # This module provides a Ruby interface for data serialization in YAML format. # -# The underlying implementation is the libyaml wrapper Psych. +# The YAML module is an alias of Psych, the YAML engine for Ruby. # # == Usage # @@ -31,6 +29,9 @@ YAML = Psych # :nodoc: # YAML.dump("foo") # => "--- foo\n...\n" # { :a => 'b'}.to_yaml # => "---\n:a: b\n" # +# As the implementation is provided by the Psych library, detailed documentation +# can be found in that library's docs (also part of standard library). +# # == Security # # Do not use YAML to load untrusted data. Doing so is unsafe and could allow |