From 1f1e2f7d7f4e510af0bba3a1d734ad67ae187d8c Mon Sep 17 00:00:00 2001 From: Piotr Murach Date: Mon, 10 Jul 2017 22:48:52 +0100 Subject: [PATCH] Add method docs --- lib/tty/command/execute.rb | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/lib/tty/command/execute.rb b/lib/tty/command/execute.rb index f55ddc3..b6b16bf 100644 --- a/lib/tty/command/execute.rb +++ b/lib/tty/command/execute.rb @@ -6,14 +6,15 @@ module TTY class Command module Execute - # Execute command in a child process + # Execute command in a child process with all IO streams piped + # in and out. The interface is similar to Process.spawn # # The caller should ensure that all IO objects are closed # when the child process is finished. However, when block # is provided this will be taken care of automatically. # # @param [Cmd] cmd - # the command to execute + # the command to spawn # # @return [pid, stdin, stdout, stderr] #