dask / distributed

A distributed task scheduler for Dask
https://distributed.dask.org
BSD 3-Clause "New" or "Revised" License
1.55k stars 712 forks source link

Avoid multiple WorkerState sphinx error #8643

Closed jrbourbeau closed 1 month ago

jrbourbeau commented 1 month ago

Currently our docs build is failing with

/home/docs/checkouts/readthedocs.org/user_builds/distributed/envs/8638/lib/python3.11/site-packages/distributed/diagnostics/plugin.py:docstring of 
distributed.diagnostics.plugin.SchedulerPlugin.valid_workers_downscaling:: WARNING: more than
one target found for cross-reference 'WorkerState': distributed.scheduler.WorkerState, distributed.worker_state_machine.WorkerState

This PR avoid that error by using the same workaround as

https://github.com/dask/distributed/blob/d5edb4e536c9acc4998f803aacc0dd0188af21ce/distributed/active_memory_manager.py#L19-L23

github-actions[bot] commented 1 month ago

Unit Test Results

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

    29 files  ±0      29 suites  ±0   10h 58m 20s :stopwatch: - 1m 49s  4 051 tests ±0   3 947 :white_check_mark:  - 2     97 :zzz: ±0  7 :x: +2  55 799 runs  ±0  53 631 :white_check_mark:  - 2  2 159 :zzz:  - 1  9 :x: +3 

For more details on these failures, see this check.

Results for commit 037176ef. ± Comparison against base commit d5edb4e5.

jrbourbeau commented 1 month ago

I'm going to merge this one in to get our docs build passing again. Happy to address any comments in a follow-up PR.