Add FAQ entry for tailRecM #1427
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Looks good to me. Thanks @travisbrown! 👍 |
|
Looks great! Thanks! @travisbrown 👍 |
peterneyens
reviewed
Oct 25, 2016
|
|
||
| ```tut:fail:silent | ||
| def tailRecM[A, B](a: A)(f: A => F[Either[A, B]]): F[B] | ||
| } |
There was a problem hiding this comment.
You have a rogue } here.
adelbertc
reviewed
Oct 25, 2016
|
|
||
| The `FlatMap` type class has a `tailRecM` method with the following signature: | ||
|
|
||
| ```tut:fail:silent |
There was a problem hiding this comment.
Should we just use scala modifier here since it's only failing because it's not implemented?
peterneyens
reviewed
Oct 25, 2016
| When you are defining a `FlatMap` instance, its `tailRecM` implementation must have two properties in order for the instance to be considered lawful. The first property is that `tailRecM` must return the same result that you would get if you recursively called `flatMap` until you got a `Right` value (assuming you had unlimited stack space—we'll get to that in a moment). In other words, it must give the same result as this implementation: | ||
|
|
||
| ```tut:silent | ||
| import cats.Monad |
There was a problem hiding this comment.
I don't think we need this import, right ?
|
Thanks, @peterneyens, @adelbertc—fixed now. |
|
👍 thanks! |
Current coverage is 92.20% (diff: 100%)@@ master #1427 diff @@
==========================================
Files 242 242
Lines 3606 3606
Methods 3537 3537
Messages 0 0
Branches 69 69
==========================================
Hits 3325 3325
Misses 281 281
Partials 0 0
|
|
I'm going to merge this since it's green, is docs, has the votes, and is going to trigger another looooong rebuild for #1430. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a draft of a FAQ entry about the (newly mandatory) stack safety of
tailRecM, as suggested by @kailuowang in #1412.