doc / ch.tutteli.atrium.assertions.builders / withFailureHint

withFailureHint

fun Descriptive.DescriptionOption<Descriptive.FinalStep>.withFailureHint(failureHintFactory: () -> Assertion): DescriptiveAssertionWithFailureHint.ShowOption (source)
Deprecated: Use withHelpOnFailure; will be removed with 1.0.0

Option to create a DescriptiveAssertion like assertion with an additional hint which might be shown if the Descriptive.DescriptionOption.test fails.

You can use withHelpOnFailureBasedOnSubject or withHelpOnFailureBasedOnDefinedSubject in case your DescriptiveAssertion is based on the subject.