Merge pull request #334 from stomar/doc_symbolize_names

Document symbolize_names keyword argument of Psych.load

1 files changed, 7 insertions, 0 deletions

diff --git a/lib/psych.rb b/lib/psych.rb
index dfb6c1b..aefc563 100644
--- a/lib/psych.rb
+++ b/lib/psych.rb
@@ -252,6 +252,13 @@ module Psych
   #     ex.file    # => 'file.txt'
   #     ex.message # => "(file.txt): found character that cannot start any token"
   #   end
+  #
+  # When the optional +symbolize_names+ keyword argument is set to a
+  # true value, returns symbols for keys in Hash objects (default: strings).
+  #
+  #   Psych.load("---\n foo: bar")                         # => {"foo"=>"bar"}
+  #   Psych.load("---\n foo: bar", symbolize_names: true)  # => {:foo=>"bar"}
+  #
   def self.load yaml, filename = nil, fallback = false, symbolize_names: false
     result = parse(yaml, filename, fallback)
     result = result.to_ruby if result