hermes-agent/n8n-openai-adapter
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #1921 from jwarwick/capture_io_docs

Browse Source 
Cleaning up ExUnit.CaptureIO docs
This commit is contained in:
José Valim
2013-12-11 03:38:19 -08:00
parent 4e2a1230f3 24725090f5
commit 898e01ccb5
1 changed files with 9 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
lib/ex_unit/lib/ex_unit/capture_io.ex
+9 -7
View File
@@ -1,6 +1,6 @@
defmodule ExUnit.CaptureIO do
@moduledoc %S"""
This module provides functionality to capture IO to test it.
Functionality to capture IO for testing.
## Examples
@@ -19,16 +19,18 @@ defmodule ExUnit.CaptureIO do
"""
@doc """
Captures IO. Returns nil in case of no output,
Captures IO generated when evaluating `fun`.
Returns `nil` in case of no output,
otherwise returns the binary which is the captured output.
By default, capture_io replaces the group_leader (`:stdio`)
By default, `capture_io` replaces the `group_leader` (`:stdio`)
for the current process. However, the capturing of any other
named device like `:stderr` is also possible globally by
giving the registered device name explicitly as argument.
named device, such as `:stderr`, is also possible globally by
giving the registered device name explicitly as an argument.
When capturing `:stdio` and the `:capture_prompt` option is `false`,
prompts (specified as arguments in IO.get* functions) are not
When capturing `:stdio`, if the `:capture_prompt` option is `false`,
prompts (specified as arguments to `IO.get*` functions) are not
captured.
A developer can set a string as an input. The default