The documentation for <data-driven-testing> fails to mention that `withData()` is only available in ...

# kotest

[Matteo Mirk]

The documentation for data-driven-testing fails to mention that withData() is only available in a container scope, so If a user tries to experiment using a StringSpec , they will be met with a compilation error and left puzzled, as it just happened to me 😄

[sam]

Once we get to Kotest 6, StringSpec will be deprecated as FreeSpec will do it all.

[sam]

StringSpec will stay as an alias to FreeSpec

[Matteo Mirk]

Ok good to know. But I think the documentation problem will remain. Even using FreeSpec I can write this:

class DataDrivenTest : FreeSpec({
    "parametric test" {
        withData(/*values*/) { ... ->
            // test code
        }
    }
})

now the class compiles but I get a runtime error:

Cannot add a root test after the spec has been instantiated:

which isn't very clear to be honest. Still, the docs fail to explain that you need to be inside a container scope to use withData(). And this applies to all the styles, that have both container and terminal scopes. Yes, the provided example shows that FunSpec's
context() is used, but I believe it may not be immediately evident for library users, especially when starting out, and it should be explained in the docs.

[sam]

I'll clarify the docs when I have a chance

[Matteo Mirk]

Thank you, just wanted to let you know, to benefit all library users. I love Kotest, thanks for your outstanding work!

[sam]

Thank you 🙂

[henrik]

Solved by using `-`: https://kotlinlang.slack.com/archives/CT0G9SD7Z/p1638810426263000?thread_ts=1638781951.257800&amp;cid=CT0G9SD7Z

[Matteo Mirk]

well, no sh*t... 🙂 I should really thank that monkey for providing a solution!

The point here is not that I didn't know how to fix it, but the documentation not being clear about where withData() can be used. Luckily the documentation has been amended now.

[henrik]

The documentation still isn't clear enough, at least not for a monkey like me 🙈

[henrik]

Also this monkey didn't realize that I posted your own answer to you 😄

[Matteo Mirk]

I agree that talking only about container or leaf scopes without any prior example is not very clear

[henrik]

Just tried to spread the joy when finally figured this out blob joy

[Matteo Mirk]

that I posted your own answer to you

yeah, that was my joke, as a monkey

[henrik]

we are all monkeys

[henrik]

this monkey clearly needs more coffee, though (or less)

[Matteo Mirk]

⬅️ I'm definitely more than others, look at my propic