arrow-kt/arrow

["Request"] Use FlowMarbles in Arrow Fx Coroutines Flow operators documentation

Open

#2458 opened on Jul 28, 2021

View on GitHub
 (5 comments) (1 reaction) (0 assignees)Kotlin (6,518 stars) (463 forks)batch import
docsenhancementhelp wanted

Description

What would you like to see?

Marble diagrams for Flow extensions.

https://github.com/rougsig/flowmarbles

Contributor guide

Tech stack
kotlin
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Kotlin coroutines FlowArrow Fx documentation setupFlowMarbles tool
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Examine the FlowMarbles library (https://github.com/rougsig/flowmarbles) and understand how to generate marble diagrams. Identify the Flow operators defined in Arrow Fx Coroutines (likely in the arrow fx coroutines module) and select a few key operators to illustrate. Then, integrate the generated diagrams into the existing documentation files, following the same style as other diagrams in the project. Review the comments on the issue (#2458) for any additional guidance from maintainers.