diff options
| -rw-r--r-- | ChangeLog | 5 | ||||
| -rw-r--r-- | ext/psych/lib/psych.rb | 8 |
2 files changed, 9 insertions, 4 deletions
@@ -1,3 +1,8 @@ +Fri Mar 1 09:18:00 2013 Zachary Scott <zachary@zacharyscott.net> + + * lib/psych.rb: specify in rdoc what object is returned in parser + By Adam Stankiewicz [Github tenderlove/psych#133] + Fri Mar 1 07:21:41 2013 Eric Hodel <drbrain@segment7.net> * lib/rubygems/ext/builder.rb: Fix incompatibilities when installing diff --git a/ext/psych/lib/psych.rb b/ext/psych/lib/psych.rb index 1384345da1..3ca6117484 100644 --- a/ext/psych/lib/psych.rb +++ b/ext/psych/lib/psych.rb @@ -252,7 +252,7 @@ module Psych end ### - # Parse a YAML string in +yaml+. Returns the first object of a YAML AST. + # Parse a YAML string in +yaml+. Returns the Psych::Nodes::Document. # +filename+ is used in the exception message if a Psych::SyntaxError is # raised. # @@ -260,7 +260,7 @@ module Psych # # Example: # - # Psych.parse("---\n - a\n - b") # => #<Psych::Nodes::Sequence:0x00> + # Psych.parse("---\n - a\n - b") # => #<Psych::Nodes::Document:0x00> # # begin # Psych.parse("--- `", "file.txt") @@ -278,7 +278,7 @@ module Psych end ### - # Parse a file at +filename+. Returns the YAML AST. + # Parse a file at +filename+. Returns the Psych::Nodes::Document. # # Raises a Psych::SyntaxError when a YAML syntax error is detected. def self.parse_file filename @@ -294,7 +294,7 @@ module Psych end ### - # Parse a YAML string in +yaml+. Returns the full AST for the YAML document. + # Parse a YAML string in +yaml+. Returns the Psych::Nodes::Stream. # This method can handle multiple YAML documents contained in +yaml+. # +filename+ is used in the exception message if a Psych::SyntaxError is # raised. |