bot: fix plugin name in _command_groups #1863
Merged
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
The "_command_groups" attribute is used to generate the documentation for plugin's command (there is an old piece of code for some undocumented feature here but that's something else). The problem is that it tries to derive the plugin's name from the Python module the callable come from, instead of, you know, the actual plugin's name. Since we added the "plugin_name" attribute on all callable back in 8776354 (see sopel-irc#1840) we can now use it safely for the command group. One-line fix for you all!
Exirel
added
the
Bugfix
dgw
approved these changes
May 18, 2020
Member
dgw
left a comment
dgw
left a comment
There was a problem hiding this comment.
Lol, this should have been an obvious thing to do in the PR that added plugin_name to callables. Oh well!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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
The "_command_groups" attribute is used to generate the documentation for plugin's command (there is an old piece of code for some undocumented feature here but that's something else).
The problem is that it tries to derive the plugin's name from the Python module the callable come from, instead of, you know, the actual plugin's name.
Since we added the "plugin_name" attribute on all callable back in 8776354 (see #1840) we can now use it safely for the command group.
One-line fix for you all!
Checklist
make qa(runsmake qualityandmake test)