Home Original page

feat(snippets): change snippet command behavior by pawbtism · Pull Request #875 · allthingslinux/tux

Reviewer's Guide

Modified the snippet command to reply contextually rather than broadcasting via ctx.send: it inspects message references and uses Message.reply or ctx.reply accordingly, preserving allowed_mentions and falling back if no reference exists.

Sequence Diagram: Snippet Command Reply Behavior

sequenceDiagram
    actor User
    participant Bot

    User->>Bot: Executes snippet command (e.g., /snippet name)
    activate Bot
    Bot->>Bot: Retrieves snippet text
    alt Command is a reply to an existing message
        participant RepliedMessage as "Message User Replied To"
        Bot->>Bot: Detects command is a reply to RepliedMessage
        Bot->>Bot: resolved_reference = RepliedMessage
        Bot-->>RepliedMessage: reply(snippet_text)
    else Command is not a reply or reference is not a message
        participant CommandMessage as "User's Command Message"
        Bot->>Bot: No valid message reference found
        Bot-->>CommandMessage: reply(snippet_text) to user's command
    end
    deactivate Bot
Loading

File-Level Changes

Change Details Files
Replace generic send with contextual reply logic
  • Removed direct ctx.send invocation
  • Added check for ctx.message.reference and its resolved target
  • Branch to reply to the referenced message if it’s a Message
  • Fallback to ctx.reply when no valid reference is present
 tux/cogs/snippets/get_snippet.py

Assessment against linked issues

Issue Objective Addressed Explanation
#870 When a snippet command is invoked as a reply to a message, the snippet response should also reply to that message. ✅

Possibly linked issues

  • Add reply to snippets #870: The PR changes snippet behavior to reply to the command, implementing the feature requested in the issue.
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