typelevel/cats

Improve doc for Func

Aperta

#2650 aperta il 30 nov 2018

Vedi su GitHubGuida contributor
 (8 commenti) (0 reazioni) (1 assegnatario)Scala (1241 fork)batch import
documentationgood first issuehelp wantedlow-hanging fruitscope: small

Metriche repository

Star
 (5438 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

Nobody knows what the hell Func does ... linking to a 25-page Haskell paper (even a good one) isn't ideal. Can we improve the doc, at least to the point of explaining why we need both Func and Kleisli and how you might use it?

There is some discussion here.

Guida contributor

Direzione di ricerca
Scrivi una documentazione chiara che spieghi lo scopo di Func, la sua relazione con Kleisli e includi esempi di utilizzo. Fai riferimento alla discussione collegata per il contesto.
Tech stack
Nessuno
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Nessuno
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90