-
-
Notifications
You must be signed in to change notification settings - Fork 2.3k
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
Fix descriptions for examples of ID-based command invocations in Mod #5372
Fix descriptions for examples of ID-based command invocations in Mod #5372
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the PR! This should also be fixed in tempban and kick command.
Also, it should probably be "user with ID ..." rather than "user ID ..." as this does not sound that great IMO.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These changes should also be made present in the documentation for the Mod cog (docs/cog_guides/mod.rst
).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks WreckRox for the PR 🎉. I'm working now to backport this PR to: 3.4. |
…n Mod (Cog-Creators#5372) * Fix wording in redbot/cogs/mod/kickban.py to match with the command example * Made changes as requested in PR Review #770078179 * Added changes to docs/cog_guides/mod.rst as requested in PR Review #70784066 * Fixed kick wording * Fix kick wording (cherry picked from commit 9aee8ce) Co-authored-by: WreckRox <24494367+WreckRox@users.noreply.github.com>
…n Mod (#5372) (#5399) * Fix wording in redbot/cogs/mod/kickban.py to match with the command example * Made changes as requested in PR Review #770078179 * Added changes to docs/cog_guides/mod.rst as requested in PR Review #70784066 * Fixed kick wording * Fix kick wording (cherry picked from commit 9aee8ce) Co-authored-by: WreckRox <24494367+WreckRox@users.noreply.github.com> Co-authored-by: WreckRox <24494367+WreckRox@users.noreply.github.com>
Description of the changes
The example command in kickban.py#L385 stated
[p]ban 428675506947227648 7 Continued to spam after told to stop. This will ban Twentysix and it will delete 7 days worth of messages.
The description is inconsistent with the example command. Changed the example command description to
This will ban the User ID 428675506947227648 and it will delete 7 days worth of messages.