From c3bad4eeab3b4244be99c97b54eb3ece21d65fd8 Mon Sep 17 00:00:00 2001 From: Rapptz Date: Thu, 18 Apr 2019 19:49:57 -0400 Subject: [PATCH] Make context documentation in migration a bit more clear. --- docs/migrating.rst | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/docs/migrating.rst b/docs/migrating.rst index 543e8f258..4dc865311 100644 --- a/docs/migrating.rst +++ b/docs/migrating.rst @@ -803,21 +803,25 @@ will either DM the user in a DM context or send a message in the channel it was 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. -Since the :class:`~ext.commands.Context` is now by default passed, several shortcuts have been added: +Since the :class:`~ext.commands.Context` is now passed by default, several shortcuts have been added: **New Shortcuts** -- :attr:`~ext.commands.Context.author` is a shortcut for ``ctx.message.author``. -- :attr:`~ext.commands.Context.guild` is a shortcut for ``ctx.message.guild``. -- :attr:`~ext.commands.Context.channel` is a shortcut for ``ctx.message.channel``. -- :attr:`~ext.commands.Context.me` is a shortcut for ``ctx.message.guild.me`` or ``ctx.bot.user``. -- :attr:`~ext.commands.Context.voice_client` is a shortcut for ``ctx.message.guild.voice_client``. +- :attr:`ctx.author ` is a shortcut for ``ctx.message.author``. +- :attr:`ctx.guild ` is a shortcut for ``ctx.message.guild``. +- :attr:`ctx.channel ` is a shortcut for ``ctx.message.channel``. +- :attr:`ctx.me ` is a shortcut for ``ctx.message.guild.me`` or ``ctx.bot.user``. +- :attr:`ctx.voice_client ` is a shortcut for ``ctx.message.guild.voice_client``. **New Functionality** -- :meth:`~.Context.reinvoke` to invoke a command again. +- :meth:`.Context.reinvoke` to invoke a command again. - This is useful for bypassing cooldowns. +- :attr:`.Context.valid` to check if a context can be invoked with :meth:`.Bot.invoke`. +- :meth:`.Context.send_help` to show the help command for an entity using the new :class:`~.ext.commands.HelpCommand` system. + + - This is useful if you want to show the user help if they misused a command. Subclassing Context ++++++++++++++++++++