diff --git a/changelog.d/3110.docs.rst b/changelog.d/3110.docs.rst new file mode 100644 index 000000000..676ce6461 --- /dev/null +++ b/changelog.d/3110.docs.rst @@ -0,0 +1 @@ +Update apikey framework documentation. Change bot.get_shared_api_keys() to bot.get_shared_api_tokens(). \ No newline at end of file diff --git a/docs/framework_apikeys.rst b/docs/framework_apikeys.rst index bfaadac40..3d68854cd 100644 --- a/docs/framework_apikeys.rst +++ b/docs/framework_apikeys.rst @@ -18,7 +18,7 @@ and when accessed in the code it should be done by .. code-block:: python - await self.bot.get_shared_api_keys("twitch") + await self.bot.get_shared_api_tokens("twitch") Each service has its own dict of key, value pairs for each required key type. If there's only one key required then a name for the key is still required for storing and accessing. @@ -30,7 +30,7 @@ and when accessed in the code it should be done by .. code-block:: python - await self.bot.get_shared_api_keys("youtube") + await self.bot.get_shared_api_tokens("youtube") *********** @@ -42,7 +42,7 @@ Basic Usage class MyCog: @commands.command() async def youtube(self, ctx, user: str): - youtube_keys = await self.bot.get_shared_api_keys("youtube") + youtube_keys = await self.bot.get_shared_api_tokens("youtube") if youtube_keys.get("api_key") is None: return await ctx.send("The YouTube API key has not been set.") # Use the API key to access content as you normally would