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

Make context documentation in migration a bit more clear.

Browse Source
This commit is contained in:
Rapptz 2019-04-18 19:49:57 -04:00
parent a7f3300821
commit c3bad4eeab
1 changed files with 11 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/migrating.rst
View File

@ -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 <ext.commands.Context.author>` is a shortcut for ``ctx.message.author``.
- :attr:`ctx.guild <ext.commands.Context.guild>` is a shortcut for ``ctx.message.guild``.
- :attr:`ctx.channel <ext.commands.Context.channel>` is a shortcut for ``ctx.message.channel``.
- :attr:`ctx.me <ext.commands.Context.me>` is a shortcut for ``ctx.message.guild.me`` or ``ctx.bot.user``.
- :attr:`ctx.voice_client <ext.commands.Context.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
++++++++++++++++++++