Be more precise about left vs right in Foldable doc #2251
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
With the previous wording, a reader might interpret the `Foldable` docs as suggesting that `foldLeft` traverses the structure from the left while `foldRight` traverses the structure from the right. In my experience, this is a common misconception. In fact, `foldRight` can terminate on infinite structures while `foldLeft` can't, which doesn't make sense if you are thinking about the two as traversal order. I've tried to be more precise about `Left` and `Right` referring to the associativity of the operations. I'm not sure whether my `List(1, 2, 3)` example is very good or not -- open to feedback
Codecov Report
@@ Coverage Diff @@
## master #2251 +/- ##
=======================================
Coverage 94.96% 94.96%
=======================================
Files 333 333
Lines 5797 5797
Branches 221 221
=======================================
Hits 5505 5505
Misses 292 292Continue to review full report at Codecov.
|
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.
With the previous wording, a reader might interpret the
Foldabledocsas suggesting that
foldLefttraverses the structure from the leftwhile
foldRighttraverses the structure from the right. In myexperience, this is a common misconception. In fact,
foldRightcanterminate on infinite structures while
foldLeftcan't, which doesn'tmake sense if you are thinking about the two as traversal order. I've
tried to be more precise about
LeftandRightreferring to theassociativity of the operations. I'm not sure whether my
List(1, 2, 3)example is very good or not -- open to feedback