Clarify documentation for readProcess
authortomjaguarpaw <tom-github.com@jaguarpaw.co.uk>
Fri, 14 Jun 2019 17:16:54 +0000 (18:16 +0100)
committerGitHub <noreply@github.com>
Fri, 14 Jun 2019 17:16:54 +0000 (18:16 +0100)
Clarify what it means to be unsuitable for running interactive processes

System/Process.hs

index cc47535..72665ad 100644 (file)
@@ -404,8 +404,8 @@ processFailedException fun cmd args exit_code =
 -- @readProcess@, the forked process will be terminated and @readProcess@ will
 -- wait (block) until the process has been terminated.
 --
--- Output is returned strictly, so this is not suitable for
--- interactive applications.
+-- Output is returned strictly, so this is not suitable for launching processes
+-- that require interaction over the standard file streams.
 --
 -- This function throws an 'IOError' if the process 'ExitCode' is
 -- anything other than 'ExitSuccess'. If instead you want to get the