Skip to content
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

Merged
merged 5 commits into from
Oct 15, 2021

Conversation

WreckRox
Copy link
Contributor

@WreckRox WreckRox commented Oct 4, 2021

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.

@github-actions github-actions bot added the Category: Cogs - Mod This is related to the Mod cog. label Oct 4, 2021
Copy link
Member

@Jackenmen Jackenmen left a 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.

@Jackenmen Jackenmen added Type: Bug Unexpected behavior, result, or exception. In case of PRs, it is a fix for the foregoing. hacktoberfest-accepted labels Oct 4, 2021
@Jackenmen Jackenmen added this to the 3.4.15 milestone Oct 4, 2021
Copy link
Member

@Kreusada Kreusada left a 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).

@github-actions github-actions bot added the Category: Docs - Other This is related to documentation that doesn't have its dedicated label. label Oct 5, 2021
@Jackenmen Jackenmen self-assigned this Oct 15, 2021
Copy link
Member

@Jackenmen Jackenmen left a comment

Choose a reason for hiding this comment

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

Looks good to me

@Jackenmen Jackenmen changed the title Fix wording in redbot/cogs/mod/kickban.py to match with the command e… [Mod] Fix the example descriptions of ID-based command invocations Oct 15, 2021
@Jackenmen Jackenmen changed the title [Mod] Fix the example descriptions of ID-based command invocations Fix the example descriptions of ID-based command invocations in Mod Oct 15, 2021
@Jackenmen Jackenmen changed the title Fix the example descriptions of ID-based command invocations in Mod Fix descriptions for examples of ID-based command invocations in Mod Oct 15, 2021
@Jackenmen Jackenmen merged commit 9aee8ce into Cog-Creators:V3/develop Oct 15, 2021
@red-githubbot
Copy link

red-githubbot bot commented Oct 15, 2021

Thanks WreckRox for the PR 🎉. I'm working now to backport this PR to: 3.4.

@red-githubbot red-githubbot bot added the Changelog Entry: Pending Changelog entry for this PR hasn't been added by repo maintainers yet. label Oct 15, 2021
Red-GitHubBot pushed a commit to Red-GitHubBot/Red-DiscordBot that referenced this pull request Oct 15, 2021
…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>
@red-githubbot
Copy link

red-githubbot bot commented Oct 15, 2021

#5399 is a backport of this pull request to Red 3.4.

Jackenmen pushed a commit that referenced this pull request Oct 15, 2021
…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>
@Jackenmen Jackenmen added Changelog Entry: Added Changelog entry for this PR has already been added to changelog PR. and removed Changelog Entry: Pending Changelog entry for this PR hasn't been added by repo maintainers yet. labels Dec 30, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Category: Cogs - Mod This is related to the Mod cog. Category: Docs - Other This is related to documentation that doesn't have its dedicated label. Changelog Entry: Added Changelog entry for this PR has already been added to changelog PR. Type: Bug Unexpected behavior, result, or exception. In case of PRs, it is a fix for the foregoing.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants