From de00573288c8b6df4206191ff2267191585c2daf Mon Sep 17 00:00:00 2001 From: Rapptz Date: Sat, 13 May 2017 23:16:40 -0400 Subject: [PATCH] Fix some broken cross references in the migrating page. --- docs/migrating.rst | 36 ++++++++++++++++-------------------- 1 file changed, 16 insertions(+), 20 deletions(-) diff --git a/docs/migrating.rst b/docs/migrating.rst index 9d770afbe..ed2ce4be2 100644 --- a/docs/migrating.rst +++ b/docs/migrating.rst @@ -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 ~~~~~~~~~~~~~~~~~