diff options
| author | Nadir Chowdhury <[email protected]> | 2021-04-16 03:41:41 +0100 |
|---|---|---|
| committer | GitHub <[email protected]> | 2021-04-15 22:41:41 -0400 |
| commit | 8f9819eb4c1c0ddd477c8ff4f80deec8aea054cc (patch) | |
| tree | 56eaf6a67ae68052b6ea78baea2bc1b8484b002a /docs | |
| parent | [commands] Remove HelpCommand.clean_prefix (#6736) (diff) | |
| download | discord.py-8f9819eb4c1c0ddd477c8ff4f80deec8aea054cc.tar.xz discord.py-8f9819eb4c1c0ddd477c8ff4f80deec8aea054cc.zip | |
[docs] Fix various unresolved references
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/ext/commands/commands.rst | 5 | ||||
| -rw-r--r-- | docs/ext/commands/extensions.rst | 4 | ||||
| -rw-r--r-- | docs/faq.rst | 6 |
3 files changed, 9 insertions, 6 deletions
diff --git a/docs/ext/commands/commands.rst b/docs/ext/commands/commands.rst index c5ad3037..b0dc3466 100644 --- a/docs/ext/commands/commands.rst +++ b/docs/ext/commands/commands.rst @@ -328,7 +328,7 @@ For example, a common idiom would be to have a class and a converter for that cl else: await ctx.send("Hm you're not so new.") -This can get tedious, so an inline advanced converter is possible through a ``classmethod`` inside the type: +This can get tedious, so an inline advanced converter is possible through a :func:`classmethod` inside the type: .. code-block:: python3 @@ -380,6 +380,7 @@ A lot of discord models work out of the gate as a parameter: - :class:`PartialMessage` (since v1.7) - :class:`TextChannel` - :class:`VoiceChannel` +- :class:`StageChannel` (since v1.7) - :class:`StoreChannel` (since v1.7) - :class:`CategoryChannel` - :class:`Invite` @@ -411,6 +412,8 @@ converter is given below: +--------------------------+-------------------------------------------------+ | :class:`VoiceChannel` | :class:`~ext.commands.VoiceChannelConverter` | +--------------------------+-------------------------------------------------+ +| :class:`StageChannel` | :class:`~ext.commands.StageChannelConverter` | ++--------------------------+-------------------------------------------------+ | :class:`StoreChannel` | :class:`~ext.commands.StoreChannelConverter` | +--------------------------+-------------------------------------------------+ | :class:`CategoryChannel` | :class:`~ext.commands.CategoryChannelConverter` | diff --git a/docs/ext/commands/extensions.rst b/docs/ext/commands/extensions.rst index 3cb6d297..20aa6e12 100644 --- a/docs/ext/commands/extensions.rst +++ b/docs/ext/commands/extensions.rst @@ -27,7 +27,7 @@ An example extension looks like this: def setup(bot): bot.add_command(hello) -In this example we define a simple command, and when the extension is loaded this command is added to the bot. Now the final step to this is loading the extension, which we do by calling :meth:`.commands.Bot.load_extension`. To load this extension we call ``bot.load_extension('hello')``. +In this example we define a simple command, and when the extension is loaded this command is added to the bot. Now the final step to this is loading the extension, which we do by calling :meth:`.Bot.load_extension`. To load this extension we call ``bot.load_extension('hello')``. .. admonition:: Cogs :class: helpful @@ -41,7 +41,7 @@ In this example we define a simple command, and when the extension is loaded thi Reloading ----------- -When you make a change to the extension and want to reload the references, the library comes with a function to do this for you, :meth:`Bot.reload_extension`. +When you make a change to the extension and want to reload the references, the library comes with a function to do this for you, :meth:`.Bot.reload_extension`. .. code-block:: python3 diff --git a/docs/faq.rst b/docs/faq.rst index f196f2b4..aa5bf976 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -236,7 +236,7 @@ technically in another thread, we must take caution in calling thread-safe opera us, :mod:`asyncio` comes with a :func:`asyncio.run_coroutine_threadsafe` function that allows us to call a coroutine from another thread. -However, this function returns a :class:`concurrent.Future` and to actually call it we have to fetch its result. Putting all of +However, this function returns a :class:`~concurrent.futures.Future` and to actually call it we have to fetch its result. Putting all of this together we can do the following: :: def my_after(error): @@ -297,7 +297,7 @@ How do I make a web request? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ To make a request, you should use a non-blocking library. -This library already uses and requires a 3rd party library for making requests, ``aiohttp``. +This library already uses and requires a 3rd party library for making requests, :doc:`aiohttp <aio:index>`. Quick example: :: @@ -395,7 +395,7 @@ Example: :: How do I make a subcommand? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Use the ``group`` decorator. This will transform the callback into a ``Group`` which will allow you to add commands into +Use the :func:`~ext.commands.group` decorator. This will transform the callback into a :class:`~ext.commands.Group` which will allow you to add commands into the group operating as "subcommands". These groups can be arbitrarily nested as well. Example: :: |