constructor.rb in rio-0.3.9

- old
+ new

@@ -1,8 +1,8 @@
 #--
 # =============================================================================== 
-# Copyright (c) 2005, 2006 Christopher Kleckner
+# Copyright (c) 2005,2006,2007 Christopher Kleckner
 # All rights reserved
 #
 # This file is part of the Rio library for ruby.
 #
 # Rio is free software; you can redistribute it and/or modify
@@ -21,20 +21,19 @@
 # =============================================================================== 
 #++
 #
 # To create the documentation for Rio run the command
 #  ruby build_doc.rb
-# from the distribution directory. Then point your browser at the 'doc/rdoc' directory.
+# from the distribution directory.
 #
 # Suggested Reading
 # * RIO::Doc::SYNOPSIS
 # * RIO::Doc::INTRO
 # * RIO::Doc::HOWTO
+# * RIO::Doc::EXAMPLES
 # * RIO::Rio
 #
-# <b>Rio is pre-alpha software. 
-# The documented interface and behavior is subject to change without notice.</b>
 
 #
 
 require 'rio'
 
@@ -134,15 +133,17 @@
   #
   # ===== Creating a Rio that refers to a StringIO object
   #
   # <tt>rio(?")</tt> (mnemonic: '"' surrounds strings)
   #
+  # <tt>rio(:string)</tt>
+  #
   # <tt>rio(:strio)</tt>
   #
-  # Alpha note: Should :strio be changed to :stringio, or even :string.
-  # Should more than one be allowed? I am leaning toward :string
+  # <tt>rio(:stringio)</tt>
   #
+  #
   # * create a Rio that refers to a string that it creates
   #    rio(?")
   # * create a Rio that refers to a string of your choosing
   #    astring = ""
   #    rio(?",astring)
@@ -216,19 +217,22 @@
   # <tt>rio(?|, ario, ...)</tt> (mnemonic: '|' is the Unix pipe operator)
   #
   # <tt>rio(:cmdpipe, ario, ...)</tt>
   #
   #
-  # See also Rio#|
+  # See also IF::Grande#|
   #
   #
   def rio(*args,&block)  # :yields: self
     Rio.rio(*args,&block) 
   end
   module_function :rio
 
   # Create a Rio as with RIO#rio which refers to the current working directory 
-  #  wd = RIO.cwd
+  #   wd = RIO.cwd
+  # If passed arguments they are treated as if
+  #   rio(RIO.cwd,*args)
+  # had been called
   def cwd(*args,&block)  # :yields: self
     Rio.new.getwd(*args,&block) 
   end
   module_function :cwd
 