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.
Add documentation around TypeClass derivation · milessabin/shapeless#219 | Good First Issue