Added examples for Cokleisli #1993
Conversation
Codecov Report
@@ Coverage Diff @@
## master #1993 +/- ##
=======================================
Coverage 95.49% 95.49%
=======================================
Files 298 298
Lines 4814 4814
Branches 120 120
=======================================
Hits 4597 4597
Misses 217 217
Continue to review full report at Codecov.
|
| * scala> def before(x: Int) = x + 1 | ||
| * scala> def after(x: Int) = x - 1 | ||
| * scala> val example : Cokleisli[Id,Int,Int] = Cokleisli((f: Id[Int]) => f.extract) | ||
| * scala> example.dimap(before)(after) == 42 |
There was a problem hiding this comment.
Can you add what this returns here and below?
There was a problem hiding this comment.
Thanks @LukaJCB for the reminder, appreciate it.
There was a problem hiding this comment.
@johnynek thanks for the review and agree with you. Following on your lead, i've revised the examples to use NonEmptyList instead, let me know what you think when you look at them?
|
@johnynek thanks for the review and i agree with you. Following your suggestion, i've changed it examples to using |
| * scala> example.dimap(before)(after) == 42 | ||
| * scala> import cats._, data._ | ||
| * scala> val f = Cokleisli((xs: NonEmptyList[Int]) => xs.reverse.head) | ||
| * f: cats.data.Cokleisli[cats.data.NonEmptyList,Int,Int] = Cokleisli(<function1>) |
There was a problem hiding this comment.
I'd omit these toString renderings, just like you omitted the output of the defs. The other examples in Cats tend to omit the trivial outputs and focus on the setup and the res0.
There was a problem hiding this comment.
@rossabaker gotcha :)
| * {{{ | ||
| * scala> import cats._, data._ | ||
| * scala> val f = Cokleisli((xs: NonEmptyList[Int]) => xs.reverse.head) | ||
| * scala> def before(x: String) = x.toInt |
There was a problem hiding this comment.
I hate to be a jerk, but can we use a function that won’t throw. I know this example is safe but using toInt in general is dangerous and I hate to set the example in docs.
Thought it might be helpful to include examples on
dimap,lmapandrmapfor learners of the library