typelevel/cats

Improve doc for Func

Open

#2,650 opened on 2018年11月30日

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

説明

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.

コントリビューターガイド

技術スタック
scala
領域
documentation
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
half day
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
Familiarity with ScalaUnderstanding of functional programming concepts
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
60
調査方針
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.
Improve doc for Func · typelevel/cats#2650 | Good First Issue