search

Kotlin / kotlinx.coroutines

Library support for Kotlin coroutines
Apache License 2.0
12.83k stars 1.83k forks source link

Marble diagrams #1815

Open r4zzz4k opened 4 years ago

r4zzz4k commented 4 years ago

ReactiveX site has a nice visualizations for describing operators called marble diagrams. They often help with understanding of the operator, e.g. for checking specifics of operator behavior, like this one:

concatMap marble diagram

One can also find that RxJS has numerous examples of interactive diagrams. On the other hand, some use plaintext versions which arguably can be also representative enough.

It would be nice to have some kind of marble diagrams for Flow operators.

rougsig commented 4 years ago

I plan to make a copy of rxmarbles but for Flow. Will make a basic version by the end of this week.

rougsig commented 4 years ago

https://flowmarbles.com/

xuanswe commented 2 years ago

I think, official docs should be updated with marble diagrams for all examples.

qwwdfsad commented 2 years ago

Unfortunately, we have neither resources nor plans to support marble diagrams on our own, and adding third-party references to kotlinlang is not the best way to go for us, though we probably should mention it in the readme

rougsig commented 2 years ago

May be i can create PR to put flowmarbles inside of your docs? Sources will be inside kotlin repo.

qwwdfsad commented 2 years ago

Great proposal! Unfortunately we are just don't have any capacity for additional activities right now and it is hard to tell whether we are ready to review and/or accept it. I do hope we'll be able to come back to it in two months or so