about summary refs log tree commit homepage
path: root/lib/kgio.rb
diff options
context:
space:
mode:
Diffstat (limited to 'lib/kgio.rb')
-rw-r--r--lib/kgio.rb10
1 files changed, 9 insertions, 1 deletions
diff --git a/lib/kgio.rb b/lib/kgio.rb
index d8b8a35..e104f46 100644
--- a/lib/kgio.rb
+++ b/lib/kgio.rb
@@ -1,10 +1,18 @@
 require 'kgio_ext'
 
 # use Kgio::Pipe.popen and Kgio::Pipe.new instead of IO.popen
-# and IO.pipe to get kgio_read and kgio_write methods.
+# and IO.pipe to get PipeMethods#kgio_read and PipeMethod#kgio_write
+# methods.
 class Kgio::Pipe < IO
   include Kgio::PipeMethods
   class << self
+
+    # call-seq:
+    #
+    #   rd, wr = Kgio::Pipe.new
+    #
+    # This creates a new pipe(7) with Kgio::Pipe objects that respond
+    # to PipeMethods#kgio_read and PipeMethod#kgio_write
     alias new pipe
   end
 end