Improve plugin API documentation #7653
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jacobtomlinson
approved these changes
Mar 14, 2023
distributed/diagnostics/plugin.py
Outdated
| For a description of the transition mechanism and the available states, | ||
| see :ref:`Scheduler task states <scheduler-task-state>`. | ||
|
|
||
| Note:: |
There was a problem hiding this comment.
Maybe this should be a warning?
Suggested change
| Note:: | |
| Warning:: |
There was a problem hiding this comment.
yeah, I was not sure how much I wanted to scare people off... I personally would prefer for this API not even to exist so I guess a warning is indeed more appropriate :)
jrbourbeau
reviewed
Mar 14, 2023
There was a problem hiding this comment.
LGTM overall -- I left a few minor suggestions. @fjetter it's close to EOD for you, if you'd like me to push this over the finish line, just let me know
jrbourbeau
approved these changes
Mar 14, 2023
ypogorelova
pushed a commit
to ypogorelova/distributed
that referenced
this pull request
Mar 16, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I was made aware of the documentation of our plugins to be a bit misleading and outdated. This should reflect reality a bit better and add some links to relevant pages.