From 91edcb053b3dd0a86ad7cec0a652d084d6e7dd46 Mon Sep 17 00:00:00 2001
From: drbrain <drbrain@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>
Date: Fri, 4 Aug 2006 22:00:31 +0000
Subject: Merge RDoc changes from HEAD.

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/branches/ruby_1_8@10679 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
---
 lib/open3.rb | 22 +++++++++++++++++-----
 1 file changed, 17 insertions(+), 5 deletions(-)

(limited to 'lib/open3.rb')

diff --git a/lib/open3.rb b/lib/open3.rb
index 59db1a4cc5..f722252b1c 100644
--- a/lib/open3.rb
+++ b/lib/open3.rb
@@ -3,12 +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')
+#
+# or:
+#
+#   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);
-- 
cgit v1.2.3