Clarify the interplay of Stream and Enum
#14002
Merged
Conversation
This file contains hidden or 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
This is based on trying to clarify/make more obvious a missunderstanding I held until ~yesterday. Namely I thought that calling an `Enum` function on a stream would result in the equivalent of `Enum.to_list` and hence all stream benefits would be forfeit. Yes, it should be clear seeing `Enum.take` work that this isn't the case, but it's not always so easy. This turned out wrong as @benwilson512 pointed out eloquently here: https://elixirforum.com/t/why-is-stream-reduce-while-missing/34422/2 Not sure if this is the best place or way to highlight this in the docs, but I thought I'd give it a shot. One could argue that this documentation belongs in the `Enum` module, but for `Stream` documentation that module is the primary source - plus it's more about `Stream`s implementation of `Enumerable`.
|
Thank you for all your great work! 💚
|
josevalim
reviewed
Nov 19, 2024
Co-authored-by: José Valim <jose.valim@gmail.com>
|
💚 💙 💜 💛 ❤️ |
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 based on trying to clarify/make more obvious a missunderstanding I held until ~yesterday.
Namely I thought that calling an
Enumfunction on a stream would result in the equivalent ofEnum.to_listand hence all stream benefits would be forfeit. Yes, it should be clear seeingEnum.takework that this isn't the case, but it's not always so easy.This turned out wrong as @benwilson512 pointed out eloquently here: https://elixirforum.com/t/why-is-stream-reduce-while-missing/34422/2
Not sure if this is the best place or way to highlight this in the docs, but I thought I'd give it a shot. One could argue that this documentation belongs in the
Enummodule, but forStreamdocumentation that module is the primary source - plus it's more aboutStreams implementation ofEnumerable.