Skip to content

docs: describe the fields returned by Client.scheduler_info - #9371

Open
nil68657 wants to merge 1 commit into
dask:mainfrom
nil68657:docs-scheduler-info
Open

nil68657 wants to merge 1 commit into
dask:mainfrom
nil68657:docs-scheduler-info

Conversation

@nil68657

Copy link
Copy Markdown

The docstring only showed an example dict that predates the current
WorkerState.identity() layout ('stored', 'active', 'time-delay' no
longer exist), so readers could not tell what any key meant. List each
scheduler-level and per-worker key with its unit, and refresh the
example to match Scheduler.identity().

This PR is a joint contribution from Nilanjan Chatterjee and Claude (Claude Opus 5.5, via Claude Code). Nilanjan chose the issue and directed the work; Claude reproduced the problem, wrote the change, its tests and this description.

Authored by Nilanjan Chatterjee (@nil68657).

The docstring only showed an example dict that predates the current
WorkerState.identity() layout ('stored', 'active', 'time-delay' no
longer exist), so readers could not tell what any key meant. List each
scheduler-level and per-worker key with its unit, and refresh the
example to match Scheduler.identity().

Closes dask#2378

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown
Contributor

Unit Test Results

See test report for an extended history of previous test failures. This is useful for diagnosing flaky tests.

    40 files  ±0      40 suites  ±0   14h 29m 27s ⏱️ + 21m 45s
 4 160 tests ±0   3 978 ✅  - 1    178 💤 ±0  4 ❌ +1 
80 961 runs  +2  76 715 ✅  - 2  4 242 💤 +3  4 ❌ +1 

For more details on these failures, see this check.

Results for commit e576b6c. ± Comparison against base commit dc182bd.

This branch has not been deployed

No deployments
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.

Client.scheduler_info needs better documentation

1 participant