summaryrefslogtreecommitdiff
path: root/lib/psych.rb
diff options
context:
space:
mode:
authorAaron Patterson <aaron.patterson@gmail.com>2010-01-03 15:26:05 -0800
committerAaron Patterson <aaron.patterson@gmail.com>2010-01-03 15:26:05 -0800
commit50eb0f3abbcc423b583c7a23a0a74620b6623342 (patch)
tree4c789eb1da13202513eb6c9d75b65fcf5bb7ea65 /lib/psych.rb
parente8f426b496602e1a3311f7b6aa812fceaa50c1d3 (diff)
downloadpsych-50eb0f3abbcc423b583c7a23a0a74620b6623342.zip
even more documentation!
Diffstat (limited to 'lib/psych.rb')
-rw-r--r--lib/psych.rb7
1 files changed, 5 insertions, 2 deletions
diff --git a/lib/psych.rb b/lib/psych.rb
index 848a71d..02925be 100644
--- a/lib/psych.rb
+++ b/lib/psych.rb
@@ -19,13 +19,16 @@ require 'psych/set'
require 'psych/psych'
###
-# Psych is a YAML parser and emitter.
+# Psych is a YAML parser and emitter. Psych leverages
+# libyaml[http://libyaml.org] for it's YAML parsing and emitting capabilities.
+# In addition to wrapping libyaml, Psych also knows how to serialize and
+# de-serialize most Ruby objects to and from the YAML format.
#
# == YAML Parsing
#
# Psych provides a range of interfaces for parsing a YAML document ranging from
# low level to high level, depending on your parsing needs. At the lowest
-# level, is an event based parser. Mid-level is access to the raw YAML AST,
+# level, is an event based parser. Mid level is access to the raw YAML AST,
# and at the highest level is the ability to unmarshal YAML to ruby objects.
#
# === Low level parsing