mirror of
https://github.com/Cog-Creators/Red-DiscordBot.git
synced 2025-12-05 17:02:32 -05:00
Fix short help in docstrings for core cogs and commands (#5502)
* fix part of command description not appearing in the help command. * Add more Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com>
This commit is contained in:
@@ -853,6 +853,7 @@ class Economy(commands.Cog):
|
||||
@economyset.command()
|
||||
async def rolepaydayamount(self, ctx: commands.Context, role: discord.Role, creds: int):
|
||||
"""Set the amount earned each payday for a role.
|
||||
|
||||
Set to `0` to remove the payday amount you set for that role.
|
||||
|
||||
Only available when not using a global bank.
|
||||
|
||||
@@ -156,6 +156,7 @@ class Warnings(commands.Cog):
|
||||
@commands.guild_only()
|
||||
async def warnchannel(self, ctx: commands.Context, channel: discord.TextChannel = None):
|
||||
"""Set the channel where warnings should be sent to.
|
||||
|
||||
Leave empty to use the channel `[p]warn` command was called in.
|
||||
"""
|
||||
guild = ctx.guild
|
||||
@@ -191,6 +192,7 @@ class Warnings(commands.Cog):
|
||||
@checks.guildowner_or_permissions(administrator=True)
|
||||
async def warnaction(self, ctx: commands.Context):
|
||||
"""Manage automated actions for Warnings.
|
||||
|
||||
Actions are essentially command macros. Any command can be run
|
||||
when the action is initially triggered, and/or when the action
|
||||
is lifted.
|
||||
@@ -204,6 +206,7 @@ class Warnings(commands.Cog):
|
||||
@commands.guild_only()
|
||||
async def action_add(self, ctx: commands.Context, name: str, points: int):
|
||||
"""Create an automated action.
|
||||
|
||||
Duplicate action names are not allowed.
|
||||
"""
|
||||
guild = ctx.guild
|
||||
@@ -255,6 +258,7 @@ class Warnings(commands.Cog):
|
||||
@checks.guildowner_or_permissions(administrator=True)
|
||||
async def warnreason(self, ctx: commands.Context):
|
||||
"""Manage warning reasons.
|
||||
|
||||
Reasons must be given a name, description and points value. The
|
||||
name of the reason must be given when a user is warned.
|
||||
"""
|
||||
@@ -369,6 +373,7 @@ class Warnings(commands.Cog):
|
||||
reason: str,
|
||||
):
|
||||
"""Warn the user for the specified reason.
|
||||
|
||||
`<points>` number of points the warning should be for. If no number is supplied
|
||||
1 point will be given. Pre-set warnings disregard this.
|
||||
`<reason>` is reason for the warning. This can be a registered reason,
|
||||
|
||||
@@ -413,8 +413,9 @@ class CogManagerUI(commands.Cog):
|
||||
async def installpath(self, ctx: commands.Context, path: Path = None):
|
||||
"""
|
||||
Returns the current install path or sets it if one is provided.
|
||||
The provided path must be absolute or relative to the bot's
|
||||
directory and it must already exist.
|
||||
|
||||
The provided path must be absolute or relative to the bot's
|
||||
directory and it must already exist.
|
||||
|
||||
No installed cogs will be transferred in the process.
|
||||
"""
|
||||
|
||||
Reference in New Issue
Block a user