Improve unreleased Command.is_enabled() and document related methods #6209
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
Jackenmen
added
Type: Bug
github-actions
bot
added
the
Category: Core - API - Commands Package
Jackenmen
added
the
Changelog Entry: Added
Flame442
requested changes
Jul 24, 2023
Co-authored-by: Michael Oliveira <[email protected]>
Flame442
approved these changes
Jul 24, 2023
Jackenmen
deleted the
improve_unreleased_public_method_and_add_docstrings
branch
Dav-Git
pushed a commit
to Dav-Git/Red-DiscordBot
that referenced
this pull request
Sep 8, 2024
…og-Creators#6209) Co-authored-by: Michael Oliveira <[email protected]>
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 of the changes
Changes the unreleased
Command.is_enabled()method (see #5552 where that was introduced) to have a more reasonable public API. I also added documentation to this method and some additional preservations toCommand.disable/enable_in()methods. The public aspect of this API was not touched on during the previous review which means that we would be intentionally exposing an API we did not intend to. This means that this PR should be considered a release blocker.This resolves #4130 and closes #5001. Note that these methods are named opposite than in both of mentioned issues -
is_enabled()instead ofis_disabled(). I'm not necessarily sure that I prefer it but it is consistent with the existingenabledattribute so it probably makes more sense this way.Have the changes in this PR been tested?
Yes