File tree Expand file tree Collapse file tree 3 files changed +17
-13
lines changed
Sources/Testing/ExitTests Expand file tree Collapse file tree 3 files changed +17
-13
lines changed Original file line number Diff line number Diff line change @@ -13,10 +13,10 @@ private import _TestingInternals
13
13
/// An enumeration describing possible conditions under which a process will
14
14
/// exit.
15
15
///
16
- /// Values of this type are used to describe the conditions under which an exit
17
- /// test is expected to pass or fail by passing them to
18
- /// ``expect (exitsWith:_:sourceLocation:performing:)`` or
19
- /// ``require(exitsWith:_:sourceLocation:performing:)`` .
16
+ /// Values of this type can be passed to
17
+ /// ``expect(exitsWith:observing:_:sourceLocation:performing:)`` or
18
+ /// ``require (exitsWith:observing: _:sourceLocation:performing:)`` to configure
19
+ /// which exit statuses should be considered successful .
20
20
@_spi ( Experimental)
21
21
#if SWT_NO_PROCESS_SPAWNING
22
22
@available ( * , unavailable, message: " Exit tests are not available on this platform. " )
Original file line number Diff line number Diff line change @@ -307,11 +307,15 @@ extension ExitTest {
307
307
/// the exit test.
308
308
///
309
309
/// This handler is invoked when an exit test (i.e. a call to either
310
- /// ``expect(exitsWith:_:sourceLocation:performing:)`` or
311
- /// ``require(exitsWith:_:sourceLocation:performing:)``) is started. The
312
- /// handler is responsible for initializing a new child environment (typically
313
- /// a child process) and running the exit test identified by `sourceLocation`
314
- /// there. The exit test's body can be found using ``ExitTest/find(at:)``.
310
+ /// ``expect(exitsWith:observing:_:sourceLocation:performing:)`` or
311
+ /// ``require(exitsWith:observing:_:sourceLocation:performing:)``) is started.
312
+ /// The handler is responsible for initializing a new child environment
313
+ /// (typically a child process) and running the exit test identified by
314
+ /// `sourceLocation` there.
315
+ ///
316
+ /// In the child environment, you can find the exit test again using
317
+ /// ``ExitTest/find(at:)`` and can be run by calling
318
+ /// ``ExitTest/callAsFunction()``.
315
319
///
316
320
/// The parent environment should suspend until the results of the exit test
317
321
/// are available or the child environment is otherwise terminated. The parent
Original file line number Diff line number Diff line change @@ -49,8 +49,8 @@ public struct ExitTestArtifacts: Sendable {
49
49
///
50
50
/// To enable gathering output from the standard output stream during an
51
51
/// exit test, pass `\.standardOutputContent` in the `observedValues`
52
- /// argument of ``expect(exitsWith:_:sourceLocation:performing:)`` or
53
- /// ``require(exitsWith:_:sourceLocation:performing:)``.
52
+ /// argument of ``expect(exitsWith:observing: _:sourceLocation:performing:)``
53
+ /// or ``require(exitsWith:observing :_:sourceLocation:performing:)``.
54
54
///
55
55
/// If the exit test could not be started or if you did not request standard
56
56
/// output content, the value of this property is the empty array.
@@ -75,8 +75,8 @@ public struct ExitTestArtifacts: Sendable {
75
75
///
76
76
/// To enable gathering output from the standard error stream during an exit
77
77
/// test, pass `\.standardErrorContent` in the `observedValues` argument of
78
- /// ``expect(exitsWith:_:sourceLocation:performing:)`` or
79
- /// ``require(exitsWith:_:sourceLocation:performing:)``.
78
+ /// ``expect(exitsWith:observing: _:sourceLocation:performing:)`` or
79
+ /// ``require(exitsWith:observing: _:sourceLocation:performing:)``.
80
80
///
81
81
/// If the exit test could not be started or if you did not request standard
82
82
/// error content, the value of this property is the empty array.
You can’t perform that action at this time.
0 commit comments