Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Indicate when a core cog is overridden in [p]cogs and debuginfo #6208

Draft
wants to merge 1 commit into
base: V3/develop
Choose a base branch
from

Conversation

Jackenmen
Copy link
Member

Description of the changes

Since core cogs can be overridden by 3rd-party cogs, this PR adds information about which cogs are overridden to debug info and provides the base implementation for [p]cogs to build on top on for @aikaterna who said that she could do the UX part. The UX isn't part of my interest here but I'll just mention that the two options that were brought up are:

  • the third section that shows only when there are any overridden cogs
  • different formatting (bold/italics/etc.) for the overridden cogs in the loaded and unloaded sections
    • this may prove a bit more difficult for the non-embed variant of the command

In both of these cases, it would be important that the user can clearly tell what this is so either the section title or additional footer with a properly worded sentence explaining it would be needed.

Have the changes in this PR been tested?

Yes

@Jackenmen Jackenmen added the Type: Enhancement Something meant to enhance existing Red features. label Jul 23, 2023
@github-actions github-actions bot added Category: Core - Command-line Interfaces This is related to Red's CLIs (redbot, redbot-launcher, redbot-setup). Category: Core - Other Internals This is related to core internals that don't have a dedicated label. labels Jul 23, 2023
@Jackenmen
Copy link
Member Author

Jackenmen commented Jul 23, 2023

Whether we want to show this to the user in [p]cogs as well is technically up for debate. I think that it would be a useful thing to have but only provided that we can get the UX right, otherwise, it's best to just leave it in debuginfo.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Category: Core - Command-line Interfaces This is related to Red's CLIs (redbot, redbot-launcher, redbot-setup). Category: Core - Other Internals This is related to core internals that don't have a dedicated label. Type: Enhancement Something meant to enhance existing Red features.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant