Skip to content

Commit

Permalink
fix scaladoc for Eval methods Unit, True, False, Zero, One (#1545)
Browse files Browse the repository at this point in the history
  • Loading branch information
sullivan- authored and kailuowang committed Mar 2, 2017
1 parent 91d8858 commit e28f9f3
Showing 1 changed file with 30 additions and 2 deletions.
32 changes: 30 additions & 2 deletions core/src/main/scala/cats/Eval.scala
Original file line number Diff line number Diff line change
Expand Up @@ -206,15 +206,43 @@ object Eval extends EvalInstances {
new Eval.Call[A](a _) {}

/**
* Static Eval instances for some common values.
* Static Eval instance for common value `Unit`.
*
* These can be useful in cases where the same values may be needed
* This can be useful in cases where the same value may be needed
* many times.
*/
val Unit: Eval[Unit] = Now(())

/**
* Static Eval instance for common value `true`.
*
* This can be useful in cases where the same value may be needed
* many times.
*/
val True: Eval[Boolean] = Now(true)

/**
* Static Eval instance for common value `false`.
*
* This can be useful in cases where the same value may be needed
* many times.
*/
val False: Eval[Boolean] = Now(false)

/**
* Static Eval instance for common value `0`.
*
* This can be useful in cases where the same value may be needed
* many times.
*/
val Zero: Eval[Int] = Now(0)

/**
* Static Eval instance for common value `1`.
*
* This can be useful in cases where the same value may be needed
* many times.
*/
val One: Eval[Int] = Now(1)

/**
Expand Down

0 comments on commit e28f9f3

Please sign in to comment.