mirrors/discord.py
1
0
Fork 0
mirror of https://github.com/Rapptz/discord.py.git synced 2025-04-19 15:36:02 +00:00
Code Issues Projects Releases Wiki Activity

Fix some broken cross references in the migrating page.

Browse Source
This commit is contained in:
Rapptz 2017-05-13 23:16:40 -04:00
parent b0dec645cb
commit de00573288
1 changed files with 16 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
docs/migrating.rst
View File

@ -688,7 +688,7 @@ undergo some design changes as well.
Context Changes
~~~~~~~~~~~~~~~~~
In v1.0, the :class:`~ext.commands.Context` has received a lot of changes with how it's retrieved and used.
In v1.0, the :class:`.Context` has received a lot of changes with how it's retrieved and used.
The biggest change is that ``pass_context=True`` is now the default behaviour. Ergo:
@ -705,7 +705,7 @@ The biggest change is that ``pass_context=True`` is now the default behaviour. E
await ctx.send('Hello')
The reason for this is because :class:`~ext.commands.Context` now meets the requirements of :class:`abc.Messageable`. This
makes it have similar functionality to :class:`TextChannel` or :class:`DMChannel`. Using :meth:`~ext.commands.Context.send`
makes it have similar functionality to :class:`TextChannel` or :class:`DMChannel`. Using :meth:`~.Context.send`
will either DM the user in a DM context or send a message in the channel it was in, similar to the old ``bot.say``
functionality. The old helpers have been removed in favour of the new :class:`abc.Messageable` interface. See
:ref:`migrating_1_0_removed_helpers` for more information.
@ -758,27 +758,23 @@ Now inside your commands you will have access to your custom context:
Removed Helpers
+++++++++++++++++
.. currentmodule:: discord.ext.commands
With the new :class:`Context` changes, a lot of message sending helpers have been removed.
With the new :class:`.Context` changes, a lot of message sending helpers have been removed.
For a full list of changes, see below:
+-----------------+----------------------------------------------------------+
| Before | After |
+-----------------+----------------------------------------------------------+
| ``Bot.say`` | :meth:`Context.send` |
+-----------------+----------------------------------------------------------+
| ``Bot.upload`` | :meth:`Context.send` |
+-----------------+----------------------------------------------------------+
| ``Bot.whisper`` | ``ctx.author.send`` |
+-----------------+----------------------------------------------------------+
| ``Bot.type`` | :meth:`Context.typing` or :meth:`Context.trigger_typing` |
+-----------------+----------------------------------------------------------+
| ``Bot.reply`` | No replacement. |
+-----------------+----------------------------------------------------------+
.. currentmodule:: discord
+-----------------+------------------------------------------------------------+
| Before | After |
+-----------------+------------------------------------------------------------+
| ``Bot.say`` | :meth:`.Context.send` |
+-----------------+------------------------------------------------------------+
| ``Bot.upload`` | :meth:`.Context.send` |
+-----------------+------------------------------------------------------------+
| ``Bot.whisper`` | ``ctx.author.send`` |
+-----------------+------------------------------------------------------------+
| ``Bot.type`` | :meth:`.Context.typing` or :meth:`.Context.trigger_typing` |
+-----------------+------------------------------------------------------------+
| ``Bot.reply`` | No replacement. |
+-----------------+------------------------------------------------------------+
Command Changes
~~~~~~~~~~~~~~~~~