Skip to content

Commit 66fa053

Browse files
authored
Merge pull request #334 from stomar/doc_symbolize_names
Document symbolize_names keyword argument of Psych.load
2 parents 307c9e3 + 47028d0 commit 66fa053

1 file changed

Lines changed: 7 additions & 0 deletions

File tree

lib/psych.rb

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -252,6 +252,13 @@ module Psych
252252
# ex.file # => 'file.txt'
253253
# ex.message # => "(file.txt): found character that cannot start any token"
254254
# end
255+
#
256+
# When the optional +symbolize_names+ keyword argument is set to a
257+
# true value, returns symbols for keys in Hash objects (default: strings).
258+
#
259+
# Psych.load("---\n foo: bar") # => {"foo"=>"bar"}
260+
# Psych.load("---\n foo: bar", symbolize_names: true) # => {:foo=>"bar"}
261+
#
255262
def self.load yaml, filename = nil, fallback = false, symbolize_names: false
256263
result = parse(yaml, filename, fallback)
257264
result = result.to_ruby if result

0 commit comments

Comments
 (0)