Add method docs

piotrmurach · Jul 10, 2017 · 1f1e2f7 · 1f1e2f7
1 parent 483e509
commit 1f1e2f7
Showing 1 changed file with 3 additions and 2 deletions.
diff --git 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]
       #