typelevel/cats

Improve doc for Func

Offen

#2.650 geöffnet am 30.11.2018

Auf GitHub ansehenContributor Guide
 (8 Kommentare) (0 Reaktionen) (1 zugewiesene Person)Scala (1.241 Forks)batch import
documentationgood first issuehelp wantedlow-hanging fruitscope: small

Repository-Metriken

Stars
 (5.438 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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.

Contributor Guide

Research-Richtung
Schreiben Sie eine klare Dokumentation, die den Zweck von Func, seine Beziehung zu Kleisli erklärt und Beispiele zur Verwendung enthält. Beziehen Sie sich auf die verlinkte Diskussion für den Kontext.
Tech Stack
Keine
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Keine
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90