span.rb in prawn-0.2.2

- old
+ new

@@ -1,6 +1,22 @@
 module Prawn
   class Document
+    # A span is a special purpose bounding box that allows a column of 
+    # elements to be positioned relative to the margin_box.  
+    #
+    # Arguments:
+    # +width+:: The width of the column in PDF points
+    #
+    # Options:
+    # <tt>:position</tt>:: One of :left, :center, :right or an x offset
+    #
+    # This method is typically used for flowing a column of text from one 
+    # page to the next.
+    #
+    #  span(350, :position => :center) do
+    #    text "Here's some centered text in a 350 point column. " * 100
+    #  end
+    #  
     def span(width, options={})
       Prawn.verify_options [:position], options
       original_position = self.y      
       
       # FIXME: How many effing times do I want to write this same code?
\ No newline at end of file