Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

More scaladoc #2132

Merged
merged 9 commits into from
Jul 24, 2021
Merged

Conversation

djspiewak
Copy link
Member

Still lots of stuff to do.

@vasilmkd
Copy link
Member

If you are making more changes, tag me as a reviewer when you're done and I'll take a look. 😄

@djspiewak djspiewak requested a review from vasilmkd July 19, 2021 15:33
@vasilmkd
Copy link
Member

I'll take a look later tonight.

Copy link
Member

@vasilmkd vasilmkd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Much appreciated scaladoc. I left a few suggestions, feel free to accept them or ignore them. I will officially Approve the PR before merging.

core/shared/src/main/scala/cats/effect/IO.scala Outdated Show resolved Hide resolved
core/shared/src/main/scala/cats/effect/IO.scala Outdated Show resolved Hide resolved
core/shared/src/main/scala/cats/effect/IO.scala Outdated Show resolved Hide resolved
core/shared/src/main/scala/cats/effect/IO.scala Outdated Show resolved Hide resolved
* {{{
* IO.println("Hello, World!").foreverM // continues printing forever
* }}}
*/
def foreverM: IO[Nothing] = Monad[IO].foreverM[A, Nothing](this)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does it matter if we change this to IO.asyncForIO.foreverM[A, Nothing](this)?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's probably slightly faster to do so in fact. Very slightly.

core/shared/src/main/scala/cats/effect/IO.scala Outdated Show resolved Hide resolved
core/shared/src/main/scala/cats/effect/IO.scala Outdated Show resolved Hide resolved
build.sbt Show resolved Hide resolved
@@ -20,16 +20,193 @@ import scala.concurrent.{blocking, CancellationException}

import java.util.concurrent.CountDownLatch

/**
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great.

Co-authored-by: Vasil Vasilev <vasil@vasilev.io>
@djspiewak djspiewak added this to the 3.2.0 milestone Jul 24, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants