[mod] Improve help of ban/kick commands. (#4715)

* better explain on how to use.

* i.... dont know why i removed that dot.

* don't think that was meant to

* Update kickban.py

* smh

* style????

* hm?

* last try to fix style......

i dont even know how to do this :/

* failing style is fun, trynna learn.

* .....

* not the best way but lets try?

* yep, didnt work dropping softban.

* Update kickban.py

* grammar fix
This commit is contained in:
MAX 2021-01-24 03:18:29 +01:00 committed by GitHub
parent 991cd46ea3
commit c11e9afec7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -270,7 +270,14 @@ class KickBanMixin(MixinMeta):
@commands.bot_has_permissions(kick_members=True) @commands.bot_has_permissions(kick_members=True)
@checks.admin_or_permissions(kick_members=True) @checks.admin_or_permissions(kick_members=True)
async def kick(self, ctx: commands.Context, user: discord.Member, *, reason: str = None): async def kick(self, ctx: commands.Context, user: discord.Member, *, reason: str = None):
"""Kick a user. """
Kick a user.
Examples:
- `[p]kick 428675506947227648 wanted to be kicked.`
This will kick Twentysix from the server.
- `[p]kick @Twentysix wanted to be kicked.`
This will kick Twentysix from the server.
If a reason is specified, it will be the reason that shows up If a reason is specified, it will be the reason that shows up
in the audit log. in the audit log.
@ -349,11 +356,18 @@ class KickBanMixin(MixinMeta):
): ):
"""Ban a user from this server and optionally delete days of messages. """Ban a user from this server and optionally delete days of messages.
`days` is the amount of days of messages to cleanup on ban.
Examples:
- `[p]ban 428675506947227648 7 Continued to spam after told to stop.`
This will ban Twentysix and it will delete 7 days worth of messages.
- `[p]ban @Twentysix 7 Continued to spam after told to stop.`
This will ban Twentysix and it will delete 7 days worth of messages.
A user ID should be provided if the user is not a member of this server. A user ID should be provided if the user is not a member of this server.
If days is not a number, it's treated as the first word of the reason. If days is not a number, it's treated as the first word of the reason.
Minimum 0 days, maximum 7. If not specified, the defaultdays setting will be used instead.
Minimum 0 days, maximum 7. If not specified, defaultdays setting will be used instead.""" """
guild = ctx.guild guild = ctx.guild
if days is None: if days is None:
days = await self.config.guild(guild).default_days() days = await self.config.guild(guild).default_days()
@ -380,8 +394,15 @@ class KickBanMixin(MixinMeta):
): ):
"""Mass bans user(s) from the server. """Mass bans user(s) from the server.
`days` is the amount of days of messages to cleanup on massban.
Example:
- `[p]massban 345628097929936898 57287406247743488 7 they broke all rules.`
This will ban all the added userids and delete 7 days of worth messages.
User IDs need to be provided in order to ban User IDs need to be provided in order to ban
using this command.""" using this command.
"""
banned = [] banned = []
errors = {} errors = {}
upgrades = [] upgrades = []
@ -543,7 +564,19 @@ class KickBanMixin(MixinMeta):
*, *,
reason: str = None, reason: str = None,
): ):
"""Temporarily ban a user from this server.""" """Temporarily ban a user from this server.
`duration` is the amount of time the user should be banned for.
`days` is the amount of days of messages to cleanup on tempban.
Examples:
- `[p]tempban @Twentysix Because I say so`
This will ban Twentysix for the default amount of time set by an administrator.
- `[p]tempban @Twentysix 15m You need a timeout`
This will ban Twentysix for 15 minutes.
- `[p]tempban 428675506947227648 1d2h15m 5 Evil person`
This will ban the user for 1 day 2 hours 15 minutes and will delete the last 5 days of their messages.
"""
guild = ctx.guild guild = ctx.guild
author = ctx.author author = ctx.author