Is there a way to add information to the assertion failures? For example if I do something like `er...

# kotest

[phil-t]

Is there a way to add information to the assertion failures?
For example if I do something like errorOccurred shouldBe false or errorOccurred.shouldBe(false) then the assertion failure says something like expected:<false> but was:<true>
Is it possible to add more information to make the problem more clear?
If it could display the name of the variable being checked that might be enough.

[sam]

You want withClue

[phil-t]

Thanks I'll give that a try.

[sam]

I will write some more docs for this

[phil-t]

That works great, also asClue seems very useful. I should have read the docs 😂

[sam]

There isn't really any docs for this

[sam]

Just what's on the front page

[sam]

Kotest has loads of amazing features no one knows about 😂

[phil-t]

I saw it on the main page about Kotest after you mentioned it, but yes I thought the docs should mention it.

[sam]

https://github.com/kotest/kotest/blob/master/doc/clues.md

[sam]

Linked to from the main reference doc now as well

[phil-t]

Very nice 👍