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
This commit is contained in:
Flame442 2019-05-24 17:52:43 -04:00 committed by Michael H
parent 49e86614c5
commit 6928e2aca2
2 changed files with 21 additions and 19 deletions

View File

@ -138,20 +138,20 @@ class Image(commands.Cog):
@checks.is_owner() @checks.is_owner()
@commands.command() @commands.command()
async def imgurcreds(self, ctx): async def imgurcreds(self, ctx):
"""Explain how to set imgur API tokens""" """Explain how to set imgur API tokens."""
message = _( message = _(
"To get an Imgur Client ID:\n" "To get an Imgur Client ID:\n"
"1. Login to an Imgur account.\n" "1. Login to an Imgur account.\n"
"2. Visit [this](https://api.imgur.com/oauth2/addclient) page\n" "2. Visit this page https://api.imgur.com/oauth2/addclient.\n"
"3. Enter a name for your application\n" "3. Enter a name for your application.\n"
"4. Select *Anonymous usage without user authorization* for the auth type\n" "4. Select *Anonymous usage without user authorization* for the auth type.\n"
"5. Set the authorization callback URL to `https://localhost`\n" "5. Set the authorization callback URL to `https://localhost`.\n"
"6. Leave the app website blank\n" "6. Leave the app website blank.\n"
"7. Enter a valid email address and a description\n" "7. Enter a valid email address and a description.\n"
"8. Check the captcha box and click next\n" "8. Check the captcha box and click next.\n"
"9. Your Client ID will be on the next page.\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,<your_client_id_here>`.\n"
).format(prefix=ctx.prefix) ).format(prefix=ctx.prefix)
await ctx.maybe_send_embed(message) await ctx.maybe_send_embed(message)

View File

@ -316,18 +316,19 @@ class Streams(commands.Cog):
@streamset.command() @streamset.command()
@checks.is_owner() @checks.is_owner()
async def twitchtoken(self, ctx: commands.Context): async def twitchtoken(self, ctx: commands.Context):
"""Explain how to set the twitch token""" """Explain how to set the twitch token."""
message = _( message = _(
"To set the twitch API tokens, follow these steps:\n" "To set the twitch API tokens, follow these steps:\n"
"1. Go to this page: https://dev.twitch.tv/dashboard/apps.\n" "1. Go to this page: https://dev.twitch.tv/dashboard/apps.\n"
"2. Click *Register Your Application*\n" "2. Click *Register Your Application*.\n"
"3. Enter a name, set the OAuth Redirect URI to `http://localhost`, and \n" "3. Enter a name, set the OAuth Redirect URI to `http://localhost`, and "
"select an Application Category of your choosing." "select an Application Category of your choosing.\n"
"4. Click *Register*, and on the following page, copy the Client ID.\n" "4. Click *Register*.\n"
"5. do `{prefix}set api twitch client_id,your_client_id`\n\n" "5. On the following page, copy the Client ID.\n"
"6. Run the command `{prefix}set api twitch client_id,<your_client_id_here>`\n\n"
"Note: These tokens are sensitive and should only be used in a private channel\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) ).format(prefix=ctx.prefix)
await ctx.maybe_send_embed(message) await ctx.maybe_send_embed(message)
@ -335,17 +336,18 @@ class Streams(commands.Cog):
@streamset.command() @streamset.command()
@checks.is_owner() @checks.is_owner()
async def youtubekey(self, ctx: commands.Context): async def youtubekey(self, ctx: commands.Context):
"""Explain how to set the YouTube token""" """Explain how to set the YouTube token."""
message = _( message = _(
"To get one, do the following:\n" "To get one, do the following:\n"
"1. Create a project\n" "1. Create a project\n"
"(see https://support.google.com/googleapi/answer/6251787 for details)\n" "(see https://support.google.com/googleapi/answer/6251787 for details)\n"
"2. Enable the YouTube Data API v3 \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" "3. Set up your API key \n"
"(see https://support.google.com/googleapi/answer/6158862 for instructions)\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,<your_api_key_here>`\n\n"
"Note: These tokens are sensitive and should only be used in a private channel\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) ).format(prefix=ctx.prefix)