Skip to content

Fix some sample outputs not being displayed in flow.md #2201

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 18, 2020
Merged

Fix some sample outputs not being displayed in flow.md #2201

merged 3 commits into from
Aug 18, 2020

Conversation

MasoudFallahpour
Copy link
Contributor

For some reason, some sample outputs in section Flow Exceptions are not displayed in the documentation. This commit fixes this issue.

For some reason, some sample outputs in section `Flow Exceptions` are not displayed in the documentation. This commit fixes this issue.
@elizarov
Copy link
Contributor

Thanks for noticing it. Indeed, the prose indicates that these should an example, but it is mistakenly hidden inside the Knit directive. However, it is not enough to replace it with a markdown code block. You should add the corresponding single-line <!--- TEST xxx --> directive directly after the markdown text block to make sure the test case is still being generated (checkout how it is done in other examples).

@MasoudFallahpour
Copy link
Contributor Author

@elizarov Based on other examples, I've added the missing directives.

@elizarov
Copy link
Contributor

The second directive was also TEST EXCEPTION. It does not pass the test anymore.

@elizarov elizarov merged commit a34a4fc into Kotlin:master Aug 18, 2020
@MasoudFallahpour MasoudFallahpour deleted the patch-4 branch August 26, 2020 19:56
recheej pushed a commit to recheej/kotlinx.coroutines that referenced this pull request Dec 28, 2020
Some sample outputs in section `Flow Exceptions` are not displayed in the documentation. This commit fixes this issue.
recheej pushed a commit to recheej/kotlinx.coroutines that referenced this pull request Dec 28, 2020
Some sample outputs in section `Flow Exceptions` are not displayed in the documentation. This commit fixes this issue.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants