Skip to content

Conversation

@Atmois
Copy link
Contributor

@Atmois Atmois commented Sep 3, 2024

Description

Fixes #493.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Other: (write here)

Guidelines

  • My code follows the style guidelines of this project (formatted with Ruff)

  • I have performed a self-review of my own code

  • I have commented my code, particularly in hard-to-understand areas

  • I have made corresponding changes to the documentation if needed

  • My changes generate no new warnings

  • I have tested this change

  • Any dependent changes have been merged and published in downstream modules

  • I have followed all of these guidelines.

How Has This Been Tested? (if applicable)

N/A

Screenshots (if applicable)

N/A

Additional Information

N/A

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Sep 3, 2024

Reviewer's Guide by Sourcery

This pull request addresses a minor bug fix in the 'editsnippet' command's usage description. The change adds a missing argument '[content]' to the command usage string, providing a more accurate representation of the command's expected input.

File-Level Changes

Change Details Files
Updated the usage string for the 'editsnippet' command to include the missing '[content]' argument
  • Modified the 'usage' parameter in the @commands.command decorator for the edit_snippet function
  • Changed 'usage="editsnippet [name]"' to 'usage="editsnippet [name] [content]"'
tux/cogs/utility/snippets.py

Tips
  • Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
  • Continue your discussion with Sourcery by replying directly to review comments.
  • You can change your review settings at any time by accessing your dashboard:
    • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
    • Change the review language;
  • You can always contact us if you have any questions or feedback.

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @Atmois - I've reviewed your changes and they look great!

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 ✨
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.

@kzndotsh kzndotsh merged commit b9aa036 into main Sep 3, 2024
@kzndotsh kzndotsh deleted the snippetHelpPatch branch September 3, 2024 14:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

edit snippet missing argument in help command

3 participants