typelevel/cats-effect

A little more `IO` and a little less `F[_]`

Open

#3,133 创建于 2022年8月27日

在 GitHub 查看
 (13 评论) (10 反应) (2 负责人)Scala (2,230 star) (572 fork)batch import
:books: docsgood first issue🥺 help wanted

描述

I think we've all converged on the idea that beginners should definitely start with concrete IO. And that there's no harm in continuing to use concrete IO indefinitely; indeed many teams are doing this.

So this is all well and good. Except our docs are full of stuff like this:

https://github.com/typelevel/cats-effect/blob/3da61a59438da30f9bb01192fec9e690aacc3ce4/std/jvm/src/main/scala/cats/effect/std/Console.scala#L30-L39

Which invariably leads to beginner questions: what is F[_]? To which a quick answer is "replace every F you see with IO".

Well, woops 😛

def myProgram[IO[_]: Console : Monad]: IO[Unit] = ???

I think we should prioritize writing examples with concrete IO, since that is exactly what we are pitching. Providing a second example written in terms of F[_] (possibly via a fancy tabbed switcher on the website) would be reserved for bonus points.

贡献者指南

技术栈
scala
领域
documentationdeveloper experience
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
half day
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
basic scala knowledgecats effect familiarity
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
90
研究方向
Review the Console.scala file linked in the issue and identify all places where F[ ] type parameter is used in doc examples. Replace those examples with concrete IO, ensuring to update any accompanying textual explanations. Consider adding a second example with F[ ] only if using a tabbed switcher, as suggested. Look at the comments for any additional feedback on specific files to modify.
A little more `IO` and a little less `F[_]` · typelevel/cats-effect#3133 | Good First Issue