Home Original page

feat(fact): improve fun facts command by electron271 · Pull Request #861 · allthingslinux/tux

Reviewer's Guide

Refactors the fun facts command to support multiple categories by introducing a FactType enum and separate fact lists, integrates slash-command metadata and a dynamic docstring decorator, and cleans up legacy hardcoded code.

File-Level Changes

Change Details Files
Introduce categorized fact data structures
  • Added linux_facts, cat_facts, and tux_facts lists
  • Created FactType enum for category labels
  • Built fact_type_map including a RANDOM category
 tux/cogs/fun/fact.py
Update fact command signature and selection logic
  • Changed command to accept a fact_type argument with default RANDOM
  • Added validation of selected category and error handling
  • Picked facts from fact_type_map and updated embed title/description
 tux/cogs/fun/fact.py
Add slash-command metadata and dynamic docstring decorator
  • Applied @app_commands.describe and @app_commands.choices for category selection
  • Implemented docstring_parameter decorator in utils/functions.py
  • Injected category options into the fact command docstring
 tux/utils/functions.py
tux/cogs/fun/fact.py
Clean up legacy code and formatting
  • Removed old self.facts attribute and commented-out embed author code
  • Added explicit return statements and updated imports
  • Streamlined embed creation by removing redundant code
 tux/cogs/fun/fact.py

Possibly linked issues

  • Add more fun facts #854: PR adds Cat and Tux fact categories and random selection to the fact command, directly addressing the issue.
  • Add more fun facts #854: The PR updates the fact command to include more categories of facts, addressing the request for random facts.
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!

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