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

[DOC] Fixed a broken code snippet with a missing method #20130

Merged
merged 1 commit into from
Nov 7, 2021

Conversation

dmatrix
Copy link
Contributor

@dmatrix dmatrix commented Nov 6, 2021

Signed-off-by: Jules S.Damji [email protected]

Why are these changes needed?

The code snippet to demonstrate how to use ActorPool is broken because a) Actor method double() is missing and b) ActoorPool.map returns a generator. To print the values you have to iterate over.

This PR fixes it and makes it work. Having code snippets that demonstrably work is a good practice as part of developer docs.

Related issue number

Checks

  • [ x] I've run scripts/format.sh to lint the changes in this PR.

@@ -652,9 +652,17 @@ Actor Pool

from ray.util import ActorPool

@ray.remote
Copy link
Contributor

Choose a reason for hiding this comment

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

Thank you for fixing this.

@rkooo567
Copy link
Contributor

rkooo567 commented Nov 7, 2021

@richardliaw @sven1977 are these snippet running in CI?

@dmatrix
Copy link
Contributor Author

dmatrix commented Nov 7, 2021

@sasha-s @rkooo567 All checks passed. Can you merge this PR? Thanks for reviewing it.

@sasha-s
Copy link
Contributor

sasha-s commented Nov 7, 2021

@sasha-s @rkooo567 All checks passed. Can you merge this PR? Thanks for reviewing it.

@dmatrix I do not have merging rights.
@ericl could you merge this please?

@rkooo567 rkooo567 merged commit e6343f0 into ray-project:master Nov 7, 2021
@dmatrix
Copy link
Contributor Author

dmatrix commented Nov 7, 2021

Thanks team!

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.

3 participants