typelevel/cats-effect

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

Open

#3,133 opened on 2022年8月27日

GitHub で見る
 (13 comments) (10 reactions) (2 assignees)Scala (2,230 stars) (572 forks)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
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
half day
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.