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.

Sign up for GitHub

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

Jump to bottom

fix scaladoc for Eval methods Unit, True, False, Zero, One #1545

Merged
merged 1 commit into from
Mar 2, 2017
Merged

fix scaladoc for Eval methods Unit, True, False, Zero, One #1545

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 30 additions & 2 deletions core/src/main/scala/cats/Eval.scala
View file
Open in desktop
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