Client.scheduler_info needs better documentation

Open Beginner friendly
#2,378 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
74/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Tech stack
python
Domain
documentation

Research direction

Start at the Client.scheduler_info API documentation linked in the issue and review the existing returned-dictionary example. Document the returned fields and explain their meanings, including the worker 'stored' value, so a reader can understand the structure without relying on the example alone.

Written by the indexing model from the issue text.

Description

documentation good first issue

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.

Dominant language
Python
Stars
1.7k
Forks
778
Avg merge
2h 50m
Merged PRs (30d)
3

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from dask/distributed

All issues in dask/distributed

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.