milessabin/shapeless

Add documentation around TypeClass derivation

Open

#219 建立於 2014年8月25日

在 GitHub 查看
 (7 留言) (0 反應) (1 負責人)Scala (3,405 star) (522 fork)batch import
DocumentationHelp wantedgood first issue

描述

The documentation around typeclass derivation points to a blog post where the derivation process is explained in a very clear manner. The problem is that this blog post mentions that there will be a part 2 that deals with the notion of co-product and how it relates to typeclass derivation. As far as my understanding goes, this blog post never made it out and there is no ressource to find more about the emptycoproduct and coproduct methods that need to need to be implemented in order to derive TypeClassCompanion

貢獻者指南

技術棧
scala
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
4
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-2 days
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Familiarity with shapeless TypeClass derivationUnderstanding of coproduct in type level programming
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
20
研究方向
The issue asks for documentation on typeclass derivation, specifically the emptycoproduct and coproduct methods. The body notes that a blog post series covers part 1 but part 2 never appeared. To contribute, review the existing documentation at the shapeless site and the source code for TypeClassCompanion. The comments may contain further clarification. Investigate the coproduct related methods in shapeless core and gather examples of their use. Since the issue is old, ensure the information is still relevant for the current version of shapeless.