CopyBot/Red-DiscordBot
1
0
Fork 0
mirror of https://github.com/Cog-Creators/Red-DiscordBot.git synced 2025-11-06 03:08:55 -05:00
Code Issues Packages Projects Releases Wiki Activity

exta info in docs about context attrs (#3151)

Browse Source 
* exta info in docs about context attrs

* changelog

* slight addition for clarity
This commit is contained in:
Michael H 2019-12-26 15:34:37 -05:00 committed by GitHub
parent df5cfabfe5
commit 153f4d20f1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
changelog.d/3151.docs.rst Normal file
View File

@ -0,0 +1 @@
Document additional attributes in Context

17
redbot/core/commands/context.py
View File

@ -20,6 +20,23 @@ class Context(commands.Context):
All context passed into commands will be of this type.
This class inherits from `discord.ext.commands.Context`.
Attributes
----------
assume_yes: bool
Whether or not interactive checks should
be skipped and assumed to be confirmed.
This is intended for allowing automation of tasks.
An example of this would be scheduled commands
not requiring interaction if the cog developer
checks this value prior to confirming something interactively.
Depending on the potential impact of a command,
it may still be appropriate not to use this setting.
permission_state: PermState
The permission state the current context is in.
"""
def __init__(self, **attrs):