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

Update asyncmap docs to clarify order of outputs #54974

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

haakon-e
Copy link
Contributor

small addition to asyncmap docstring to clarify that order of output is same as input:

The output is guaranteed to be the same order as the elements of the collection(s) c.

I added it to clarify the behavior, especially for new users, and, afaik because it is not consistent across programming languages.

Happy to iterate if there should be updates to doc pages too.

@Seelengrab
Copy link
Contributor

Should this actually be guaranteed, or is this a case of "that's what it happens to do right now"?

@haakon-e
Copy link
Contributor Author

Should this actually be guaranteed, or is this a case of "that's what it happens to do right now"?

I will have to defer a definitive answer to that question for someone else. I'm basing my PR on the answer to a question I had about this in the julia slack. In any case, clarification either way for what I should expect (or not expect) would be useful to have in the docs.

@ericphanson
Copy link
Contributor

It should be semantically guaranteed since it is supposed to be like map (and this order is a big reason this function is useful)

@nsajko nsajko added the domain:docs This change adds or pertains to documentation label Jul 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
domain:docs This change adds or pertains to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants