diff options
author | zzak <zzak@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2013-03-01 00:18:50 +0000 |
---|---|---|
committer | zzak <zzak@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2013-03-01 00:18:50 +0000 |
commit | 6213b8370c54bed04b6f9901cd89e9a6fa08557a (patch) | |
tree | 28f66ae6823af5f6be672be9bffe441e34084608 /ext/psych/lib | |
parent | a5dfaca00a94bc3d135aae52b4458f5a355bf0ed (diff) | |
download | ruby-6213b8370c54bed04b6f9901cd89e9a6fa08557a.tar.gz |
* lib/psych.rb: specify in rdoc what object is returned in parser
By Adam Stankiewicz [Github tenderlove/psych#133]
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@39543 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'ext/psych/lib')
-rw-r--r-- | ext/psych/lib/psych.rb | 8 |
1 files changed, 4 insertions, 4 deletions
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. |