adding sequence documentation

1 files changed, 29 insertions, 0 deletions

diff --git a/lib/psych/nodes/sequence.rb b/lib/psych/nodes/sequence.rb
index 9b87f61..ff5a642 100644
--- a/lib/psych/nodes/sequence.rb
+++ b/lib/psych/nodes/sequence.rb
@@ -1,5 +1,34 @@
 module Psych
   module Nodes
+    ###
+    # This class represents a
+    # {YAML sequence}[http://yaml.org/spec/1.1/#sequence/syntax].
+    #
+    # A YAML sequence is basically a list, and looks like this:
+    #
+    #   %YAML 1.1
+    #   ---
+    #   - I am
+    #   - a Sequence
+    #
+    # A YAML sequence may have an anchor like this:
+    #
+    #   %YAML 1.1
+    #   ---
+    #   &A [
+    #     "This sequence",
+    #     "has an anchor"
+    #   ]
+    #
+    # A YAML sequence may also have a tag like this:
+    #
+    #   %YAML 1.1
+    #   ---
+    #   !!seq [
+    #     "This sequence",
+    #     "has an anchor"
+    #   ]
+    #
     class Sequence < Psych::Nodes::Node
       # The anchor for this sequence (if any)
       attr_accessor :anchor