Update Flow.sample KDoc example timings, add tests #2259
Conversation
* All Flow.debounce/sample KDoc example code snippets are automatically tested with Knit. * Flow.sample timings are made larger, so that they produce an expected output when run under the real time, too. Fixes #2243
elizarov
force-pushed
the
flow-sample-doc
branch
from
763a37f to
d1bb071
Compare
| @@ -33,7 +50,14 @@ import kotlin.time.* | |||
| * emit(5) | |||
| * }.debounce(1000) | |||
| * ``` | |||
| * produces `3, 4, 5`. | |||
| * <!--- KNIT example-delay-01.kt --> | |||
There was a problem hiding this comment.
It would be nice if these tests could be numbered automatically without interfering with the source.
In general, I do no mind having Knit-specific directives in our markdown, but this documentation will likely be read from the IDEA rather than from a webpage with processed markdown, so reducing the number of MD tags would be nice
There was a problem hiding this comment.
They are automatically numbered. When writing those directives you can use any number or even just a placeholder like <!--- KNIT example-delay-num.kt --> and when you run gradlew knit it will renumber them sequentially and will update the corresponding source files.
| @@ -14,13 +14,30 @@ import kotlinx.coroutines.selects.* | |||
| import kotlin.jvm.* | |||
| import kotlin.time.* | |||
|
|
|||
| /* Scaffolding for Knit code examples | |||
| <!--- TEST_NAME FlowDelayTest --> | |||
There was a problem hiding this comment.
Same here, would be nice to hide it in an external file
There was a problem hiding this comment.
Yes. That would be a nice addition. Created Kotlin/kotlinx-knit#18 and Kotlin/kotlinx-knit#19
* All Flow.debounce/sample KDoc example code snippets are automatically tested with Knit. * Flow.sample timings are made larger, so that they produce an expected output when run under the real time, too. Fixes Kotlin#2243
* All Flow.debounce/sample KDoc example code snippets are automatically tested with Knit. * Flow.sample timings are made larger, so that they produce an expected output when run under the real time, too. Fixes Kotlin#2243
Fixes #2243