Skip to content

Commit d636dc0

Browse files
committed
Proof-read the doc for capture_io
1 parent ed0b161 commit d636dc0

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

lib/ex_unit/lib/ex_unit/capture_io.ex

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
defmodule ExUnit.CaptureIO do
22
@moduledoc %B"""
33
This module provides functionality to capture IO to test it.
4-
The way to use this module is to import them into your module.
54
65
## Examples
76
@@ -21,16 +20,16 @@ defmodule ExUnit.CaptureIO do
2120

2221
@doc """
2322
Captures IO. Returns nil in case of no output,
24-
otherwise returns the binary which is captured outputs.
23+
otherwise returns the binary which is the captured output.
2524
2625
By default, capture_io replaces the group_leader (`:stdio`)
2726
for the current process. However, the capturing of any other
2827
named device like `:stderr` is also possible globally by
2928
giving the registered device name explicitly as argument.
3029
31-
When capturing of `:stdio` and the `:capture_prompt` option
32-
is not `false`, this function captures a prompt, otherwise
33-
do not.
30+
When capturing `:stdio` and the `:capture_prompt` option is `false`,
31+
prompts (specified as arguments in IO.get* functions) are not
32+
captured.
3433
3534
A developer can set a string as an input. The default
3635
input is `:eof`.

0 commit comments

Comments
 (0)