Skip to content

Commit cd7d0fc

Browse files
committed
Update docs for IntoInitializableOutput
1 parent d20515d commit cd7d0fc

1 file changed

Lines changed: 7 additions & 3 deletions

File tree

src/assertions/general/outputs/initializable.rs

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,13 @@ impl InitializableOutput for AssertionOutput {
3333

3434
/// An output type that can be converted into an
3535
/// [initializable output type](InitializableOutput).
36+
///
37+
/// This allows assertions to succeed or fail on their own rather than
38+
/// returning a result from a different assertion. An assertion's output
39+
/// must implement [`InitializableOutput`] to call [`pass`] or [`fail`].
40+
///
41+
/// [`pass`]: AssertionContext::pass
42+
/// [`fail`]: AssertionContext::fail
3643
pub trait IntoInitializableOutput {
3744
/// The initialized output type.
3845
///
@@ -42,9 +49,6 @@ pub trait IntoInitializableOutput {
4249
type Initialized: InitializableOutput;
4350

4451
/// Converts this output into an instance of the initialized output type.
45-
///
46-
/// This is important to ensure that an existing instance of this output can
47-
/// be converted to the success/failure types this output can produce.
4852
fn into_initialized(self) -> Self::Initialized;
4953
}
5054

0 commit comments

Comments
 (0)