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.

Sign up for GitHub

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 Plugin Help #3322

Open
wants to merge 4 commits into
base: development
Choose a base branch
from
Open

Fix Plugin Help #3322

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
61336bc
Merge pull request #3269 from modmail-dev/development
Taaku18 Nov 26, 2023
f392cec
Updates Plugin Wiki Link
martinbndr Dec 11, 2023
9f814f9
Fix @local/name doc
martinbndr May 5, 2024
49ebca0
Chnaged Plugin Help Link for #3322
martinbndr Nov 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions cogs/plugins.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ class Plugins(commands.Cog):
These addons could have a range of features from moderation to simply
making your life as a moderator easier!
Learn how to create a plugin yourself here:
https://github.com/modmail-dev/modmail/wiki/Plugins
https://docs.modmail.dev/old-docs/plugins
martinbndr marked this conversation as resolved.
Show resolved Hide resolved
"""

def __init__(self, bot):
Expand Down Expand Up @@ -326,7 +326,7 @@ async def parse_user_input(self, ctx, plugin_name, check_version=False):
embed = discord.Embed(
description="Invalid plugin name, double check the plugin name "
"or use one of the following formats: "
"username/repo/plugin-name, username/repo/plugin-name@branch, local/plugin-name.",
"username/repo/plugin-name, username/repo/plugin-name@branch, @local/plugin-name.",
color=self.bot.error_color,
)
await ctx.send(embed=embed)
Expand All @@ -351,7 +351,7 @@ async def plugins_add(self, ctx, *, plugin_name: str):

`plugin_name` can be the name of the plugin found in `{prefix}plugin registry`,
or a direct reference to a GitHub hosted plugin (in the format `user/repo/name[@branch]`)
or `local/name` for local plugins.
or `@local/name` for local plugins.
"""

plugin = await self.parse_user_input(ctx, plugin_name, check_version=True)
Expand Down Expand Up @@ -435,7 +435,7 @@ async def plugins_remove(self, ctx, *, plugin_name: str):
Remove an installed plugin of the bot.

`plugin_name` can be the name of the plugin found in `{prefix}plugin registry`, or a direct reference
to a GitHub hosted plugin (in the format `user/repo/name[@branch]`) or `local/name` for local plugins.
to a GitHub hosted plugin (in the format `user/repo/name[@branch]`) or `@local/name` for local plugins.
"""
plugin = await self.parse_user_input(ctx, plugin_name)
if plugin is None:
Expand Down Expand Up @@ -515,7 +515,7 @@ async def plugins_update(self, ctx, *, plugin_name: str = None):
Update a plugin for the bot.

`plugin_name` can be the name of the plugin found in `{prefix}plugin registry`, or a direct reference
to a GitHub hosted plugin (in the format `user/repo/name[@branch]`) or `local/name` for local plugins.
to a GitHub hosted plugin (in the format `user/repo/name[@branch]`) or `@local/name` for local plugins.

To update all plugins, do `{prefix}plugins update`.
"""
Expand Down
Loading