docs: improve and compare Promise.each and Promise.mapSeries #1565
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.
From the docs for
Promise.each
:This pull request is a rewrite of the documentation of
Promise.each
, making it complete (I believe).Also,
Promise.mapSeries
is very similar toPromise.each
(the former was born in #821 based onPromise.each
), so I thought that the documentations of both functions should be more closely related. This way, this pull request also rewrites the documentation ofPromise.mapSeries
, yielding two similar documentations that clarify the difference between both functions.Not only rewriting the text, I also changed the examples to ones that I believe to be clearer and more insightful (also better formatted), showing better the differences between both functions.
This is my first contribution, hopefully I've done it right and will be able to help :) Let me know if I missed something or have to further improve something.