From 21d438243dd1afb335277e8cbef801eff07c0346 Mon Sep 17 00:00:00 2001
From: akr <akr@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>
Date: Thu, 4 Dec 2008 14:35:19 +0000
Subject: rdoc update.

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

(limited to 'lib/open3.rb')

diff --git a/lib/open3.rb b/lib/open3.rb
index 7bf330c825..e70aaca6ef 100644
--- a/lib/open3.rb
+++ b/lib/open3.rb
@@ -195,6 +195,13 @@ module Open3
   #
   # If opts[:stdin_data] is specified, it is sent to the command's standard input.
   #
+  # Example:
+  #
+  #   o, e, s = Open3.poutput3("echo a; sort >&2", :stdin_data=>"foo\nbar\nbaz\n")
+  #   p o #=> "a\n"
+  #   p e #=> "bar\nbaz\nfoo\n"
+  #   p s #=> #<Process::Status: pid 32682 exit 0>
+  #
   def poutput3(*cmd, &block)
     if Hash === cmd.last
       opts = cmd.pop.dup
-- 
cgit v1.2.3