Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: improve and compare Promise.each and Promise.mapSeries #1565

Merged
merged 1 commit into from Feb 28, 2019
Merged

Conversation

papb
Copy link
Contributor

@papb papb commented Nov 13, 2018

From the docs for Promise.each:

This article is partially or completely unfinished. You are welcome to create pull requests to help completing this article.

This pull request is a rewrite of the documentation of Promise.each, making it complete (I believe).

Also, Promise.mapSeries is very similar to Promise.each (the former was born in #821 based on Promise.each), so I thought that the documentations of both functions should be more closely related. This way, this pull request also rewrites the documentation of Promise.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.

@papb
Copy link
Contributor Author

papb commented Jan 22, 2019

@benjamingr Sorry to ping for attention, but this PR is probably super easy to review, it is frustrating to take so long. I'm sure you're super busy but can you spare 5 minutes? I would be more than happy to help with other parts of the docs which also say that You are welcome to create pull requests to help completing this article but the delay is frustrating. Thank you so much.

Copy link
Collaborator

@benjamingr benjamingr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@petkaantonov can we do a docs rebuild after this?

@papb
Copy link
Contributor Author

papb commented Feb 28, 2019

@benjamingr - Thank you so much for the review! Do we only have to wait now? Is there something else you can do, or we just have to wait more for @petkaantonov ? Thanks again.

@benjamingr benjamingr merged commit 63b15da into petkaantonov:master Feb 28, 2019
@papb
Copy link
Contributor Author

papb commented Mar 29, 2019

@benjamingr - Looks like the docs are still old even though this PR was merged one month ago. Can you take a look into this please? Thanks 😬

@benjamingr
Copy link
Collaborator

@petkaantonov can you run a docs rebuild (with the release you did)?

@papb
Copy link
Contributor Author

papb commented May 24, 2019

Ping @petkaantonov

@petkaantonov
Copy link
Owner

rebuilt docs and pushed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants