Add option to hide bot owner in help command

[electron271]

Introduce a configuration option to hide the bot owner in the help command, while also displaying the bot owner and version information when the option is disabled.

Summary by Sourcery

New Features:

• Allow hiding the bot owner in the help command via a configuration option.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request introduces a configuration option to hide the bot owner in the help command. When the option is disabled, the bot owner and version information are displayed.

Sequence diagram for help command with bot owner visibility option

sequenceDiagram
    actor User
    participant Discord
    participant HelpCommand
    participant Config

    User->>Discord: Invokes help command
    Discord->>HelpCommand: Triggers help command
    HelpCommand->>Config: Check HIDE_BOT_OWNER setting
    Config-->>HelpCommand: Return visibility setting
    alt HIDE_BOT_OWNER is false
        HelpCommand->>HelpCommand: Add bot owner info to embed
    else HIDE_BOT_OWNER is true
        HelpCommand->>HelpCommand: Skip bot owner info
    end
    HelpCommand-->>Discord: Return help embed
    Discord-->>User: Display help message

Loading

Class diagram showing Config class changes

classDiagram
    class Config {
        +BOT_NAME: str
        +BOT_VERSION: str
        +ACTIVITIES: str
        +HIDE_BOT_OWNER: bool
        +DEBUG: bool
    }
    note for Config "Added HIDE_BOT_OWNER configuration option"

Loading

File-Level Changes

Change	Details	Files
Added a configuration option to hide the bot owner in the help command.	Added a HIDE_BOT_OWNER configuration option in tux/utils/config.py. Added a conditional check in tux/help.py to display the bot owner and version information based on the HIDE_BOT_OWNER configuration. Added HIDE_BOT_OWNER to the example configuration file config/settings.yml.example.	tux/help.py tux/utils/config.py config/settings.yml.example

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!
• Generate a plan of action for an issue: Comment @sourcery-ai plan on
  an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @electron271 - I've reviewed your changes - here's some feedback:

Overall Comments:

• The settings.yml.example diff appears to be truncated - please include the changes showing how to configure the HIDE_BOT_OWNER option in the example config file

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}