aboutsummaryrefslogtreecommitdiffstats
path: root/lib/open3.rb
diff options
context:
space:
mode:
authordrbrain <drbrain@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2006-08-04 18:05:50 +0000
committerdrbrain <drbrain@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2006-08-04 18:05:50 +0000
commit52c034aecb365c6cf2a41b8648c3e87fb335fdaf (patch)
tree199813273b1cd9a90b40e3dc797303d0e5f8c67b /lib/open3.rb
parent4db2df633cc784c40e21b3df38fe9a6dd1b0ff0b (diff)
downloadruby-52c034aecb365c6cf2a41b8648c3e87fb335fdaf.tar.gz
Documentation cleanup.
Includes patches by Hugh Sasse: * ping.rb * weakref.rb * mailread.rb git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@10668 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'lib/open3.rb')
-rw-r--r--lib/open3.rb25
1 files changed, 15 insertions, 10 deletions
diff --git a/lib/open3.rb b/lib/open3.rb
index 69a29aace1..f722252b1c 100644
--- a/lib/open3.rb
+++ b/lib/open3.rb
@@ -3,19 +3,24 @@
# which IO#popen does not allow)
#
# Usage:
-# require "open3"
#
-# stdin, stdout, stderr = Open3.popen3('nroff -man')
-# or
-# include Open3
-# stdin, stdout, stderr = popen3('nroff -man')
+# require "open3"
+#
+# stdin, stdout, stderr = Open3.popen3('nroff -man')
#
-# popen3 can also take a block which will receive stdin, stdout and stderr
-# as parameters. This ensures stdin, stdout and stderr are closed once
-# the block exits.
+# or:
#
-# Such as
-# Open3.popen3('nroff -man') { |stdin, stdout, stderr| ... }
+# include Open3
+#
+# stdin, stdout, stderr = popen3('nroff -man')
+#
+# popen3 can also take a block which will receive stdin, stdout and stderr as
+# parameters. This ensures stdin, stdout and stderr are closed once the block
+# exits.
+#
+# Such as:
+#
+# Open3.popen3('nroff -man') { |stdin, stdout, stderr| ... }
module Open3
#[stdin, stdout, stderr] = popen3(command);