typelevel/cats

Improve doc for Func

Open

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

在 GitHub 查看
 (8 留言) (0 反應) (1 負責人)Scala (1,241 fork)batch import
documentationgood first issuehelp wantedlow-hanging fruitscope: small

倉庫指標

Star
 (5,438 star)
PR 合併指標
 (平均合併 4小時 2分鐘) (30 天內合併 5 個 PR)

描述

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.

貢獻者指南

研究方向
編寫清晰的文檔，解釋Func的目的、與Kleisli的關係，並包含使用示例。參考連結討論獲取上下文。
技術棧
無
領域
documentation
議題類型
文件
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
1
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
半天
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
活躍
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
清晰
前置要求
無
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
90