From 6928e2aca2712cd959a67b34ec2862ee597740b5 Mon Sep 17 00:00:00 2001 From: Flame442 <34169552+Flame442@users.noreply.github.com> Date: Fri, 24 May 2019 17:52:43 -0400 Subject: [PATCH] Fixes some issues with API help commands (#2729) * Fixes some issues with `[p]streamset youtubekey/twitchtoken` Lots of general formatting bugs and clarity issues. * General formatting bugs and clarity issues --- redbot/cogs/image/image.py | 18 +++++++++--------- redbot/cogs/streams/streams.py | 22 ++++++++++++---------- 2 files changed, 21 insertions(+), 19 deletions(-) diff --git a/redbot/cogs/image/image.py b/redbot/cogs/image/image.py index 7c2148bbf..060e809c0 100644 --- a/redbot/cogs/image/image.py +++ b/redbot/cogs/image/image.py @@ -138,20 +138,20 @@ class Image(commands.Cog): @checks.is_owner() @commands.command() async def imgurcreds(self, ctx): - """Explain how to set imgur API tokens""" + """Explain how to set imgur API tokens.""" message = _( "To get an Imgur Client ID:\n" "1. Login to an Imgur account.\n" - "2. Visit [this](https://api.imgur.com/oauth2/addclient) page\n" - "3. Enter a name for your application\n" - "4. Select *Anonymous usage without user authorization* for the auth type\n" - "5. Set the authorization callback URL to `https://localhost`\n" - "6. Leave the app website blank\n" - "7. Enter a valid email address and a description\n" - "8. Check the captcha box and click next\n" + "2. Visit this page https://api.imgur.com/oauth2/addclient.\n" + "3. Enter a name for your application.\n" + "4. Select *Anonymous usage without user authorization* for the auth type.\n" + "5. Set the authorization callback URL to `https://localhost`.\n" + "6. Leave the app website blank.\n" + "7. Enter a valid email address and a description.\n" + "8. Check the captcha box and click next.\n" "9. Your Client ID will be on the next page.\n" - "10. do `{prefix}set api imgur client_id,your_client_id`\n" + "10. Run the command `{prefix}set api imgur client_id,`.\n" ).format(prefix=ctx.prefix) await ctx.maybe_send_embed(message) diff --git a/redbot/cogs/streams/streams.py b/redbot/cogs/streams/streams.py index 3893dcf18..cd7478f88 100644 --- a/redbot/cogs/streams/streams.py +++ b/redbot/cogs/streams/streams.py @@ -316,18 +316,19 @@ class Streams(commands.Cog): @streamset.command() @checks.is_owner() async def twitchtoken(self, ctx: commands.Context): - """Explain how to set the twitch token""" + """Explain how to set the twitch token.""" message = _( "To set the twitch API tokens, follow these steps:\n" "1. Go to this page: https://dev.twitch.tv/dashboard/apps.\n" - "2. Click *Register Your Application*\n" - "3. Enter a name, set the OAuth Redirect URI to `http://localhost`, and \n" - "select an Application Category of your choosing." - "4. Click *Register*, and on the following page, copy the Client ID.\n" - "5. do `{prefix}set api twitch client_id,your_client_id`\n\n" + "2. Click *Register Your Application*.\n" + "3. Enter a name, set the OAuth Redirect URI to `http://localhost`, and " + "select an Application Category of your choosing.\n" + "4. Click *Register*.\n" + "5. On the following page, copy the Client ID.\n" + "6. Run the command `{prefix}set api twitch client_id,`\n\n" "Note: These tokens are sensitive and should only be used in a private channel\n" - "or in DM with the bot.)\n" + "or in DM with the bot.\n" ).format(prefix=ctx.prefix) await ctx.maybe_send_embed(message) @@ -335,17 +336,18 @@ class Streams(commands.Cog): @streamset.command() @checks.is_owner() async def youtubekey(self, ctx: commands.Context): - """Explain how to set the YouTube token""" + """Explain how to set the YouTube token.""" message = _( "To get one, do the following:\n" "1. Create a project\n" "(see https://support.google.com/googleapi/answer/6251787 for details)\n" "2. Enable the YouTube Data API v3 \n" - "(see https://support.google.com/googleapi/answer/6158841for instructions)\n" + "(see https://support.google.com/googleapi/answer/6158841 for instructions)\n" "3. Set up your API key \n" "(see https://support.google.com/googleapi/answer/6158862 for instructions)\n" - "4. Copy your API key and do `{prefix}set api youtube api_key,your_api_key`\n\n" + "4. Copy your API key and run the command " + "`{prefix}set api youtube api_key,`\n\n" "Note: These tokens are sensitive and should only be used in a private channel\n" "or in DM with the bot.\n" ).format(prefix=ctx.prefix)