ruby-changes:50501
From: eregon <ko1@a...>
Date: Fri, 2 Mar 2018 21:56:42 +0900 (JST)
Subject: [ruby-changes:50501] eregon:r62635 (trunk): Clarify the documentation of the YAML module [Misc #14567]
eregon 2018-03-02 21:56:37 +0900 (Fri, 02 Mar 2018) New Revision: 62635 https://svn.ruby-lang.org/cgi-bin/viewvc.cgi?view=revision&revision=62635 Log: Clarify the documentation of the YAML module [Misc #14567] Based on a patch from Victor Shepelev Modified files: trunk/lib/yaml.rb Index: lib/yaml.rb =================================================================== --- lib/yaml.rb (revision 62634) +++ lib/yaml.rb (revision 62635) @@ -1,6 +1,4 @@ https://github.com/ruby/ruby/blob/trunk/lib/yaml.rb#L1 # 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: https://github.com/ruby/ruby/blob/trunk/lib/yaml.rb#L15 # # 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: https://github.com/ruby/ruby/blob/trunk/lib/yaml.rb#L29 # 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 -- ML: ruby-changes@q... Info: http://www.atdot.net/~ko1/quickml/