plugin: clean up redundant in-docstring parameter type annotations #2539
Conversation
This file contains hidden or 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
SnoopJ
approved these changes
Nov 1, 2023
dgw
force-pushed
the
plugin-docstring-types
branch
from
78c21ee to
d0e9e24
Compare
Exirel
approved these changes
Nov 1, 2023
Contributor
Exirel
left a comment
Exirel
left a comment
There was a problem hiding this comment.
Aside from a nitpick mentioned by SnoopJ, I really like that!
Member
Author
|
I'm going to rebase with a few more tweaks ahead of @SnoopJ's rereview. Found some more things I could clean up, in particular some of the more confusing decorator type-hints ( |
I've definitely gone a little beyond that exact description in the name of improving consistency, but that's the gist.
dgw
force-pushed
the
plugin-docstring-types
branch
from
fd84b3e to
cec43ee
Compare
The appearance of `Any` in the docs for plugin decorators bugged me so I worked on the type annotations until it was no longer used in the file.
dgw
force-pushed
the
plugin-docstring-types
branch
from
cec43ee to
08b670c
Compare
Member
Author
|
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.
Description
I realized that leaving parameter types in the docstrings of these decorators is a maintenance nightmare waiting to happen. Our docs show the type-hints in the function signatures very nicely now. Putting types in the parameter list too is just redundant.
Checklist
make qa(runsmake lintandmake test)