Revisit documentation #161
Conversation
| } | ||
| ``` | ||
|
|
||
| Like `test`, `testIn` produces a `ReceiveTurbine`. |
There was a problem hiding this comment.
ReceiveTurbine as a type was not mentioned above in the test section.
That section probably just needs a quick tweak like
Then it calls the validation block, passing in the read-only interface
ReceiveTurbineas the receiver:
README.md
Outdated
| While flow termination is exposed as an event, it is not really an event: it's a state that the flow is in. | ||
| So completion or error events can be observed multiple times. | ||
|
|
||
| ```kotlin | ||
| flow<Nothing> { throw RuntimeException("broken!") }.test { | ||
| awaitError() | ||
| awaitError() | ||
| awaitError() | ||
| } | ||
| ``` |
There was a problem hiding this comment.
Not sure whether this meets that bar for the intro/README. It's a great snippet to put on the kdoc of each of these functions (which we should do no matter what), but I'm unsure as to whether it's something important enough to actively communicate here. What do you think?
There was a problem hiding this comment.
Makes sense to me. I was very worried about this README getting too long, so.... happy to have a reason to delete something
There was a problem hiding this comment.
This is already documented well enough, I think:
/**
* Assert that the next event received was an error terminating the flow.
* This function will suspend if no events have been received.
*
* When this [ReceiveTurbine] is in a terminal state ([Event.Complete] or [Event.Error], this method
* will yield the same result every time it is called.
*
* @throws AssertionError if the next event was an item or completion.
*/
jingibus
force-pushed
the
wphillips/2022-10-13/update-documentation
branch
from
e80858c
to
d398b12
Compare
No description provided.