CopyBot/Red-DiscordBot
1
0
Fork 0
mirror of https://github.com/Cog-Creators/Red-DiscordBot.git synced 2025-11-06 11:18:54 -05:00
Code Issues Packages Projects Releases Wiki Activity

[Downloader] Cleaned up commands' docstrings, del -> delete

Browse Source
This commit is contained in:
Twentysix 2017-06-18 01:50:41 +02:00
parent feffb56847
commit 03791b9fbc
1 changed files with 4 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
cogs/downloader/downloader.py
View File

@ -180,11 +180,9 @@ class Downloader:
async def _repo_add(self, ctx, name: RepoName, repo_url: str, branch: str=None): async def _repo_add(self, ctx, name: RepoName, repo_url: str, branch: str=None):
""" """
Add a new repo to Downloader. Add a new repo to Downloader.
:param name: Name that must follow python variable naming rules and
contain only characters A-Z and numbers 0-9 and _ Name can only contain characters A-z, numbers and underscore
:param repo_url: Clone url for the cog repo Branch will default to master if not specified
:param branch: Specify branch if you want it to be different than
repo default.
""" """
try: try:
# noinspection PyTypeChecker # noinspection PyTypeChecker
@ -201,11 +199,10 @@ class Downloader:
else: else:
await ctx.send("Repo `{}` successfully added.".format(name)) await ctx.send("Repo `{}` successfully added.".format(name))
@repo.command(name="del") @repo.command(name="delete")
async def _repo_del(self, ctx, repo_name: Repo): async def _repo_del(self, ctx, repo_name: Repo):
""" """
Removes a repo from Downloader and its' files. Removes a repo from Downloader and its' files.
:param repo_name: Repo name in Downloader
""" """
await self._repo_manager.delete_repo(repo_name.name) await self._repo_manager.delete_repo(repo_name.name)
@ -234,8 +231,6 @@ class Downloader:
async def _cog_install(self, ctx, repo_name: Repo, cog_name: str): async def _cog_install(self, ctx, repo_name: Repo, cog_name: str):
""" """
Installs a cog from the given repo. Installs a cog from the given repo.
:param repo_name:
:param cog_name: Cog name available from `[p]cog list <repo_name>`
""" """
cog = discord.utils.get(repo_name.available_cogs, name=cog_name) cog = discord.utils.get(repo_name.available_cogs, name=cog_name)
if cog is None: if cog is None:
@ -261,7 +256,6 @@ class Downloader:
""" """
Allows you to uninstall cogs that were previously installed Allows you to uninstall cogs that were previously installed
through Downloader. through Downloader.
:param cog_name:
""" """
# noinspection PyUnresolvedReferences,PyProtectedMember # noinspection PyUnresolvedReferences,PyProtectedMember
real_name = cog_name.name real_name = cog_name.name
@ -281,7 +275,6 @@ class Downloader:
async def _cog_update(self, ctx, cog_name: InstalledCog=None): async def _cog_update(self, ctx, cog_name: InstalledCog=None):
""" """
Updates all cogs or one of your choosing. Updates all cogs or one of your choosing.
:param cog_name:
""" """
if cog_name is None: if cog_name is None:
updated = await self._repo_manager.update_all_repos() updated = await self._repo_manager.update_all_repos()
@ -304,7 +297,6 @@ class Downloader:
async def _cog_list(self, ctx, repo_name: Repo): async def _cog_list(self, ctx, repo_name: Repo):
""" """
Lists all available cogs from a single repo. Lists all available cogs from a single repo.
:param repo_name: Repo name available from `[p]repo list`
""" """
cogs = repo_name.available_cogs cogs = repo_name.available_cogs
cogs = "Available Cogs:\n" + "\n".join( cogs = "Available Cogs:\n" + "\n".join(
@ -316,8 +308,6 @@ class Downloader:
async def _cog_info(self, ctx, repo_name: Repo, cog_name: str): async def _cog_info(self, ctx, repo_name: Repo, cog_name: str):
""" """
Lists information about a single cog. Lists information about a single cog.
:param repo_name:
:param cog_name:
""" """
cog = discord.utils.get(repo_name.available_cogs, name=cog_name) cog = discord.utils.get(repo_name.available_cogs, name=cog_name)
if cog is None: if cog is None: