typelevel/cats

Improve doc for Func

Open

#2,650 建立於 2018年11月30日

在 GitHub 查看
 (8 留言) (0 反應) (1 負責人)Scala (5,438 star) (1,241 fork)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
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
half day
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
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