lib/rio/constructor.rb in rio-0.3.4 vs lib/rio/constructor.rb in rio-0.3.6

@@ -196,9 +196,22 @@
   #
   # <tt>rio(:cmdio,cmd)</tt>
   #
   # This is Rio's interface to IO#popen
   #
+  # ===== Creating a Rio Pipe
+  #
+  # A Rio Pipe is a sequence of Rios that are run with the output of each being
+  # copied to the input of the next.
+  #
+  # <tt>rio(?|, ario, ...)</tt> (mnemonic: '|' is the Unix pipe operator)
+  #
+  # <tt>rio(:cmdpipe, ario, ...)</tt>
+  #
+  #
+  # See also Rio#|
+  #
+  #
   def rio(*args,&block)  # :yields: self
     Rio.rio(*args,&block) 
   end
   module_function :rio