adds more details to random.md documentation #3792
Conversation
armanbilge
force-pushed
the
series/3.5.x
branch
from
911d23f
to
6a4dcfe
Compare
docs/std/random.md
Outdated
|
|
||
| // use the standard implementation of Random backed by java.util.Random() | ||
| // (the same implementation as Random.javaUtilRandom(43)) | ||
| implicit val r: IO[Random[IO]] = Random.scalaUtilRandom[IO] |
There was a problem hiding this comment.
Is having an implicit IO[A] a common pattern? I don't think I've ever seen it. I would expect an implicit Random[IO] here (but of course that opens the question of "should Random be passed implicitly").
There was a problem hiding this comment.
I agree this seems odd and it doesn't make sense in this context why it's used implicitly. I changed it to be an explicit param.
docs/std/random.md
Outdated
|
|
||
| // for testing, create a Random instance that gives back the same number every time. With | ||
| // this version of the Random type class, we can test our business logic works as intended. | ||
| implicit val r: IO[Random[IO]] = IO( |
There was a problem hiding this comment.
| implicit val r: IO[Random[IO]] = IO( | |
| implicit val r: IO[Random[IO]] = IO.pure( |
docs/std/random.md
Outdated
| implicit val r: IO[Random[IO]] = IO( | ||
| new Random[IO] { | ||
| def betweenInt(minInclusive: Int, maxExclusive: Int): IO[Int] = | ||
| IO(7) // gives back 7 every call |
There was a problem hiding this comment.
| IO(7) // gives back 7 every call | |
| IO.pure(7) // gives back 7 every call |
|
Looks like the build failures are legitimate |
|
sorry, I don't get what I need to do to fix this issue. Can someone point me the right direction? |
|
Looks like import errors. Use Do you know how to run it locally? Thanks for your work! |
docs/std/random.md
Outdated
| import cats.effect.std.Random | ||
| import cats.syntax.all |
There was a problem hiding this comment.
| import cats.syntax.all | |
| import cats.syntax.all._ |
|
I feel we should retain the example of using I would like to expand this example into a working copy-and-paste example. This example at current state does not show how |
Adds more detailed documentation for the
Randomtype, including a unit test example.