fun Descriptive.DescriptionOption<Descriptive.FinalStep>.withHelpOnFailure(failureHintFactory: () -> Assertion): DescriptiveAssertionWithFailureHint.ShowOption
(source)
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.