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

[DEV DOCS] Documentation of Scheduler and Worker state machine #5413

Closed
Tracked by #190 ...
fjetter opened this issue Oct 13, 2021 · 0 comments · Fixed by #6948
Closed
Tracked by #190 ...

[DEV DOCS] Documentation of Scheduler and Worker state machine #5413

fjetter opened this issue Oct 13, 2021 · 0 comments · Fixed by #6948
Assignees
Labels
documentation Improve or add to documentation

Comments

@fjetter
Copy link
Member

fjetter commented Oct 13, 2021

Parent issue: dask/community#190

The scheduler state machine is documented in https://distributed.dask.org/en/stable/scheduling-state.html

This docs page has a few problems we should address. Below a few

  • Reading flow is interrupted by object references which breaks the reading flow
  • It is not discussed how the scheduler state machine maps onto the worker state machine although there is typically a 1:N mapping
  • The page is placed in the "build understanding" section. We want to have a documentation which offers enough information for developers. We might want to consider splitting this off into user and developer sections
  • The entire scheduler class reference is part of this page which is likely an error
  • Many things changed about the implementation over the past months and we should ensure it is still up to date. In particular the list of stimuli feels out of date
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
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants