sopel-irc / sopel

:robot::speech_balloon: An easy-to-use and highly extensible IRC Bot framework. Formerly Willie.
https://sopel.chat
Other
951 stars 405 forks source link

plugin: clean up redundant in-docstring parameter type annotations #2539

Closed dgw closed 8 months ago

dgw commented 8 months ago

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

dgw commented 8 months ago

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 (plugin no longer even imports typing.Any in my local copy 🥳).

dgw commented 8 months ago
13:20:57 <+dgw> SnoopJ, did you want to take another look at #2539 or should I just ship it?
13:21:38 <+SnoopJ> nah, ship it