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

Client.scheduler_info needs better documentation #2378

Open
mikewheel opened this issue Nov 27, 2018 · 1 comment
Open

Client.scheduler_info needs better documentation #2378

mikewheel opened this issue Nov 27, 2018 · 1 comment
Labels
documentation Improve or add to documentation good first issue Clearly described and easy to accomplish. Good for beginners to the project.

Comments

@mikewheel
Copy link
Contributor

https://distributed.readthedocs.io/en/latest/api.html#distributed.Client.scheduler_info provides a single example of the dictionary returned, but there's no explanation of what those fields mean. Take for example 'stored': 0 under the worker -- the example alone doesn't do enough to explain what that actually means. A list of the fields being returned and their interpretations would go a long way.

@mrocklin
Copy link
Member

Sorry for the delay in response. Yes, I agree that this could be improved. This would be a welcome contribution if anyone is interested.

@GenevieveBuckley GenevieveBuckley added documentation Improve or add to documentation good first issue Clearly described and easy to accomplish. Good for beginners to the project. labels Oct 19, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improve or add to documentation good first issue Clearly described and easy to accomplish. Good for beginners to the project.
Projects
None yet
Development

No branches or pull requests

3 participants