Skip to content

Commit 7d37c3a

Browse files
NCPlayzRapptz
authored andcommitted
[docs] Fix various unresolved references
1 parent 4d47436 commit 7d37c3a

File tree

6 files changed

+16
-13
lines changed

6 files changed

+16
-13
lines changed

discord/abc.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -743,10 +743,10 @@ async def move(self, **kwargs):
743743
Whether to move the channel to the end of the
744744
channel list (or category if given).
745745
This is mutually exclusive with ``beginning``, ``before``, and ``after``.
746-
before: :class:`abc.Snowflake`
746+
before: :class:`~discord.abc.Snowflake`
747747
The channel that should be before our current channel.
748748
This is mutually exclusive with ``beginning``, ``end``, and ``after``.
749-
after: :class:`abc.Snowflake`
749+
after: :class:`~discord.abc.Snowflake`
750750
The channel that should be after our current channel.
751751
This is mutually exclusive with ``beginning``, ``end``, and ``before``.
752752
offset: :class:`int`
@@ -756,7 +756,7 @@ async def move(self, **kwargs):
756756
while a negative number moves it above. Note that this
757757
number is relative and computed after the ``beginning``,
758758
``end``, ``before``, and ``after`` parameters.
759-
category: Optional[:class:`abc.Snowflake`]
759+
category: Optional[:class:`~discord.abc.Snowflake`]
760760
The category to move this channel under.
761761
If ``None`` is given then it moves it out of the category.
762762
This parameter is ignored if moving a category channel.

discord/embeds.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -438,7 +438,7 @@ def remove_author(self):
438438

439439
@property
440440
def fields(self):
441-
"""Union[List[:class:`EmbedProxy`], :attr:`Empty`]: Returns a :class:`list` of ``EmbedProxy`` denoting the field contents.
441+
"""List[Union[``EmbedProxy``, :attr:`Empty`]]: Returns a :class:`list` of ``EmbedProxy`` denoting the field contents.
442442
443443
See :meth:`add_field` for possible values you can access.
444444

discord/message.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1332,8 +1332,8 @@ async def ack(self):
13321332
async def reply(self, content=None, **kwargs):
13331333
"""|coro|
13341334
1335-
A shortcut method to :meth:`abc.Messageable.send` to reply to the
1336-
:class:`Message`.
1335+
A shortcut method to :meth:`.abc.Messageable.send` to reply to the
1336+
:class:`.Message`.
13371337
13381338
.. versionadded:: 1.6
13391339
@@ -1349,7 +1349,7 @@ async def reply(self, content=None, **kwargs):
13491349
13501350
Returns
13511351
---------
1352-
:class:`Message`
1352+
:class:`.Message`
13531353
The message that was sent.
13541354
"""
13551355

docs/ext/commands/commands.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -327,7 +327,7 @@ For example, a common idiom would be to have a class and a converter for that cl
327327
else:
328328
await ctx.send("Hm you're not so new.")
329329
330-
This can get tedious, so an inline advanced converter is possible through a ``classmethod`` inside the type:
330+
This can get tedious, so an inline advanced converter is possible through a :func:`classmethod` inside the type:
331331

332332
.. code-block:: python3
333333
@@ -379,6 +379,7 @@ A lot of discord models work out of the gate as a parameter:
379379
- :class:`PartialMessage` (since v1.7)
380380
- :class:`TextChannel`
381381
- :class:`VoiceChannel`
382+
- :class:`StageChannel` (since v1.7)
382383
- :class:`StoreChannel` (since v1.7)
383384
- :class:`CategoryChannel`
384385
- :class:`Invite`
@@ -410,6 +411,8 @@ converter is given below:
410411
+--------------------------+-------------------------------------------------+
411412
| :class:`VoiceChannel` | :class:`~ext.commands.VoiceChannelConverter` |
412413
+--------------------------+-------------------------------------------------+
414+
| :class:`StageChannel` | :class:`~ext.commands.StageChannelConverter` |
415+
+--------------------------+-------------------------------------------------+
413416
| :class:`StoreChannel` | :class:`~ext.commands.StoreChannelConverter` |
414417
+--------------------------+-------------------------------------------------+
415418
| :class:`CategoryChannel` | :class:`~ext.commands.CategoryChannelConverter` |

docs/ext/commands/extensions.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ An example extension looks like this:
2727
def setup(bot):
2828
bot.add_command(hello)
2929
30-
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')``.
30+
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')``.
3131

3232
.. admonition:: Cogs
3333
:class: helpful
@@ -41,7 +41,7 @@ In this example we define a simple command, and when the extension is loaded thi
4141
Reloading
4242
-----------
4343

44-
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`.
44+
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`.
4545

4646
.. code-block:: python3
4747

docs/faq.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -234,7 +234,7 @@ technically in another thread, we must take caution in calling thread-safe opera
234234
us, :mod:`asyncio` comes with a :func:`asyncio.run_coroutine_threadsafe` function that allows us to call
235235
a coroutine from another thread.
236236

237-
However, this function returns a :class:`concurrent.Future` and to actually call it we have to fetch its result. Putting all of
237+
However, this function returns a :class:`~concurrent.futures.Future` and to actually call it we have to fetch its result. Putting all of
238238
this together we can do the following: ::
239239

240240
def my_after(error):
@@ -295,7 +295,7 @@ How do I make a web request?
295295
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
296296

297297
To make a request, you should use a non-blocking library.
298-
This library already uses and requires a 3rd party library for making requests, ``aiohttp``.
298+
This library already uses and requires a 3rd party library for making requests, :doc:`aiohttp <aio:index>`.
299299

300300
Quick example: ::
301301

@@ -393,7 +393,7 @@ Example: ::
393393
How do I make a subcommand?
394394
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
395395

396-
Use the ``group`` decorator. This will transform the callback into a ``Group`` which will allow you to add commands into
396+
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
397397
the group operating as "subcommands". These groups can be arbitrarily nested as well.
398398

399399
Example: ::

0 commit comments

Comments
 (0)