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

[Image] Improve explanations of arguments in docstrings and help (#4874)

Browse Source 
* Initial commit

* Give arguments their descriptions

* Add usage

* fixes for black
This commit is contained in:
Kreusada 2021-04-05 21:16:41 +01:00 committed by GitHub
parent 3c742e39d2
commit d1ed41c46b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
redbot/cogs/image/image.py
View File

@ -47,12 +47,12 @@ class Image(commands.Cog):
""" """
pass pass
@_imgur.command(name="search") @_imgur.command(name="search", usage="[count] <terms...>")
async def imgur_search(self, ctx, count: UserInputOptional[int] = 1, *, term: str): async def imgur_search(self, ctx, count: UserInputOptional[int] = 1, *, term: str):
"""Search Imgur for the specified term. """Search Imgur for the specified term.
Use `count` to choose how many images should be returned. - `[count]`: How many images should be returned (maximum 5). Defaults to 1.
Command can return up to 5 images. - `<terms...>`: The terms used to search Imgur.
""" """
if count < 1 or count > 5: if count < 1 or count > 5:
await ctx.send(_("Image count has to be between 1 and 5.")) await ctx.send(_("Image count has to be between 1 and 5."))
@ -98,10 +98,10 @@ class Image(commands.Cog):
): ):
"""Get images from a subreddit. """Get images from a subreddit.
You can customize the search with the following options: - `<subreddit>`: The subreddit to get images from.
- `<count>`: number of images to return (up to 5) - `[count]`: The number of images to return (maximum 5). Defaults to 1.
- `<sort_type>`: new, top - `[sort_type]`: New, or top results. Defaults to top.
- `<window>`: day, week, month, year, all - `[window]`: The timeframe, can be the past day, week, month, year or all. Defaults to day.
""" """
if count < 1 or count > 5: if count < 1 or count > 5:
await ctx.send(_("Image count has to be between 1 and 5.")) await ctx.send(_("Image count has to be between 1 and 5."))
@ -175,9 +175,12 @@ class Image(commands.Cog):
await ctx.maybe_send_embed(message) await ctx.maybe_send_embed(message)
@commands.guild_only() @commands.guild_only()
@commands.command() @commands.command(usage="<keywords...>")
async def gif(self, ctx, *, keywords): async def gif(self, ctx, *, keywords):
"""Retrieve the first search result from Giphy.""" """Retrieve the first search result from Giphy.
- `<keywords...>`: The keywords used to search Giphy.
"""
giphy_api_key = (await ctx.bot.get_shared_api_tokens("GIPHY")).get("api_key") giphy_api_key = (await ctx.bot.get_shared_api_tokens("GIPHY")).get("api_key")
if not giphy_api_key: if not giphy_api_key:
await ctx.send( await ctx.send(
@ -199,9 +202,12 @@ class Image(commands.Cog):
await ctx.send(_("Error contacting the Giphy API.")) await ctx.send(_("Error contacting the Giphy API."))
@commands.guild_only() @commands.guild_only()
@commands.command() @commands.command(usage="<keywords...>")
async def gifr(self, ctx, *, keywords): async def gifr(self, ctx, *, keywords):
"""Retrieve a random GIF from a Giphy search.""" """Retrieve a random GIF from a Giphy search.
- `<keywords...>`: The keywords used to generate a random GIF.
"""
giphy_api_key = (await ctx.bot.get_shared_api_tokens("GIPHY")).get("api_key") giphy_api_key = (await ctx.bot.get_shared_api_tokens("GIPHY")).get("api_key")
if not giphy_api_key: if not giphy_api_key:
await ctx.send( await ctx.send(