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

Documentation for async #18

Closed
benjamingr opened this issue Oct 2, 2015 · 0 comments
Closed

Documentation for async #18

benjamingr opened this issue Oct 2, 2015 · 0 comments

Comments

@benjamingr
Copy link

I think the documentation for .async is very misleading since it says:

An throttled version of Promise.all

A lot of people, in my experience answering questions in StackOverflow, being involved in the spec process and helping maintain a library is that a lot of people mix up the fact a promise is a proxy for the value of an already started operation.

A throttled Promise.all is impossible of course since all the inputs to .all are already promises which means the operations themselves have already started.

It would be useful to update the documentation to reflect that, also it would be nice if the docs were moved to an API.md file or something similar.

@ysmood ysmood closed this as completed in 57b1f13 Oct 10, 2015
ysmood added a commit that referenced this issue Oct 10, 2015
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

No branches or pull requests

1 participant