typelevel/cats

Improve doc for Func

Open

#2650 opened on Nov 30, 2018

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

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

Tech stack
scala
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Familiarity with ScalaUnderstanding of functional programming concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Review the existing Scala documentation for the Func type in the cats library. Examine the discussion in PR #388 and related comments to understand the confusion. Provide a clear explanation of Func, its relationship to Kleisli, and use cases. Target file: likely the Func.scala source file or Scaladoc.