From 6092bb2affd9195dcfe21c44802f26c7a3faae61 Mon Sep 17 00:00:00 2001
From: nobu <nobu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>
Date: Sun, 20 Sep 2009 00:53:37 +0000
Subject: * lib/open3.rb (Open3#popen3): fixed and improved rdoc. 
 [ruby-core:25658]

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

(limited to 'lib')

diff --git a/lib/open3.rb b/lib/open3.rb
index c4dacc9473..fca0257cdd 100644
--- a/lib/open3.rb
+++ b/lib/open3.rb
@@ -33,7 +33,7 @@ module Open3
   #   
   #   require 'open3'
   #
-  #   [stdin, stdout, stderr] = Open3.popen3(cmd)
+  #   stdin, stdout, stderr = Open3.popen3(cmd)
   #
   # Block form:
   #
@@ -43,6 +43,12 @@ module Open3
   #
   # The parameter +cmd+ is passed directly to Kernel#exec.
   #
+  # _popen3_ is like _system_ in that you can pass extra parameters, and the
+  # strings won't be mangled by shell expansion.
+  #
+  #   stdin, stdout, stderr = Open3.popen3('identify', '/weird path/with spaces/and "strange" characters.jpg')
+  #   result = stdout.read
+  #
   def popen3(*cmd)
     pw = IO::pipe   # pipe[0] for read, pipe[1] for write
     pr = IO::pipe
-- 
cgit v1.2.3