Updated List.filterMap documentation with more realistic examples #866
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.
I made a change to the
filterMap
documentation in theList
module to provide more realistic examples of its use.The old text:
To someone who may not have a good understanding of what
Maybe
is used for, I think this raises the question: "Why does myisTeen
function even return aMaybe Int
to begin with? Why not returnBool
and usefilter
?" In my opinion this is a very contrived example.As an alternative, my suggested example text is an application of the
head
andidentity
functions, where one can build a good intuition of whyMaybe
values are produced. My suggested text: