diff options
| author | Zachary Scott <zachary@zacharyscott.net> | 2013-02-28 19:15:53 -0500 |
|---|---|---|
| committer | Zachary Scott <zachary@zacharyscott.net> | 2013-02-28 19:15:53 -0500 |
| commit | edf05c9f40e0c566e391f7e04b4a30327c31a828 (patch) | |
| tree | 1e3aeb75f3fc490d27c2f3e5937147f74b1a2179 | |
| parent | 03659ce6d3e7db458c38f1c0973cf1bdf0824acf (diff) | |
| download | psych-edf05c9f40e0c566e391f7e04b4a30327c31a828.zip | |
* lib/psych.rb: specify in rdoc what object is returned in parser
By Adam Stankiewicz [Github Fixes #133]
| -rw-r--r-- | CHANGELOG.rdoc | 5 | ||||
| -rw-r--r-- | lib/psych.rb | 8 |
2 files changed, 9 insertions, 4 deletions
diff --git a/CHANGELOG.rdoc b/CHANGELOG.rdoc index cb66a48..9f28f80 100644 --- a/CHANGELOG.rdoc +++ b/CHANGELOG.rdoc @@ -1,3 +1,8 @@ +Fri Mar 1 09:15:00 2013 Zachary Scott <zachary@zacharyscott.net> + + * lib/psych.rb: specify in rdoc what object is returned in parser + By Adam Stankiewicz [Github Fixes #133] + Fri Mar 1 03:22:00 2013 Zachary Scott <zachary@zacharyscott.net> * lib/psych.rb: rdoc for Psych overview by Adam Stankiewicz diff --git a/lib/psych.rb b/lib/psych.rb index 1384345..3ca6117 100644 --- a/lib/psych.rb +++ b/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. |