typelevel/cats

Improve doc for Func

Open

#2,650 opened on Nov 30, 2018

View on GitHub
 (8 comments) (0 reactions) (1 assignee)Scala (1,241 forks)batch import
documentationgood first issuehelp wantedlow-hanging fruitscope: small

Repository metrics

Stars
 (5,438 stars)
PR merge metrics
 (Avg merge 4h 2m) (5 merged PRs in 30d)

Description

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 direction
Write clear documentation explaining the purpose of Func, its relationship to Kleisli, and include usage examples. Refer to the linked discussion for context.
Tech stack
None
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90