arrow-kt/arrow

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

Ouverte

#2 458 ouverte le 28 juil. 2021

Voir sur GitHubGuide contributeur
 (5 commentaires) (1 réaction) (0 personne assignée)Kotlin (463 forks)batch import
docsenhancementhelp wanted

Métriques du dépôt

Stars
 (6 518 étoiles)
Métriques de merge PR
 (Merge moyen 3j 16h) (17 PRs mergées en 30 j)

Description

What would you like to see?

Marble diagrams for Flow extensions.

https://github.com/rougsig/flowmarbles

Guide contributeur

Direction de recherche
Examinez la bibliothèque FlowMarbles (https://github.com/rougsig/flowmarbles) et comprenez comment générer des diagrammes de billes. Identifiez les opérateurs Flow définis dans Arrow Fx Coroutines (probablement dans le module arrow fx coroutines) et sélectionnez quelques opérateurs clés à illustrer. Ensuite, intégrez les diagrammes générés dans les fichiers de documentation existants, en suivant le même style que les autres diagrammes du projet. Consultez les commentaires sur l'issue (#2458) pour toute directive supplémentaire des mainteneurs.
Stack technique
kotlin
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Aucun
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80