54 Commits

Author SHA1 Message Date
NCPlayz
1b0e806245 [commands] Implement commands.before/after_invoke 2020-04-04 02:57:20 -04:00
Rapptz
2ba28bbfe2 One last superfluous .0 in versionadded 2020-01-22 21:12:02 -05:00
Rapptz
d9cd4a3561 [commands] Implement Command.__call__ 2020-01-21 04:27:20 -05:00
Rapptz
4de314d2c3 [commands] Export max_concurrency and MaxConcurrencyReached in docs 2020-01-21 03:35:43 -05:00
Rapptz
a2b241446e [commands] Document BucketType separately 2020-01-18 20:04:00 -05:00
Rapptz
82797b0e60 [commands] Add missing CheckAnyFailure documentation 2020-01-14 19:54:10 -05:00
Rapptz
92a3c1b583 [commands] Document guild permission checks 2020-01-07 04:50:52 -05:00
Rapptz
ae3dac0d59 [commands] Add check_any check to OR together various checks 2020-01-06 22:03:56 -05:00
Rapptz
c62b6c3e88 Fix more deprecation warnings for 3.8 2019-11-26 05:19:11 -05:00
Flame442
5cad76370e [commands] Fix grammar
Either implies that there will be two things, there is only one.
2019-10-17 05:56:01 -04:00
Dante Dam
da41cceb41 [commands] Fix confusion between it's and its 2019-07-22 20:46:40 -04:00
Dante Dam
956f4c7151 [commands] Fix CategoryChannel not appearing in converter table 2019-07-18 18:06:27 -04:00
Rapptz
7543328fe7 Update Sphinx to 2.1.2 2019-06-28 01:43:04 -04:00
Rapptz
a8f0a03247 Version bump to 1.2.0 2019-06-09 00:39:38 -04:00
NCPlayz
3c9bcc2851 Improve documentation 2019-06-07 19:27:46 -04:00
Rapptz
f8cc64ca7e Add changelog for v1.1.0 2019-05-10 20:19:51 -04:00
Rapptz
d51f4c2b81 Minor nits in Discord Converters section of the docs. 2019-05-09 07:40:08 -04:00
Rapptz
446b79241c Actually use multiple checks in the examples for checks. 2019-05-01 23:57:50 -04:00
Rapptz
91e00d8426 [tasks] Add way to query cancellation state for Loop.after_loop
Fixes #2121
2019-04-30 01:45:15 -04:00
Rapptz
55e3e242ff [tasks] Remove support for awaitables due to gotchas.
Fixes #2079
2019-04-29 23:34:20 -04:00
Vexs
bb3ebc0ebc [commands] Add custom exception classes for built-in checks
Added:
* MissingRole
* BotMissingRole
* MissingAnyRole
* BotMissingAnyRole
2019-04-20 16:45:37 -04:00
Rapptz
296d4bf580 [commands] Add new MessageConverter to commands prose page. 2019-04-17 22:41:58 -04:00
retke
440db2a568 [commands] Add MessageConverter to fetch messages by URL or ID. 2019-04-17 20:47:21 -04:00
Rapptz
e46842a7cd [tasks] Add before_loop and after_loop decorators 2019-04-12 04:08:42 -04:00
Rapptz
4cf96107ae [tasks] Document version added 2019-04-11 08:26:46 -04:00
Rapptz
10bc939348 [tasks] Rename Loop.run to Loop.start to avoid blocking connotations 2019-04-11 08:19:32 -04:00
Rapptz
b0c7f48caf [tasks] Add a new background helper 'tasks' extension. 2019-04-11 08:04:26 -04:00
Rapptz
d9e54d7dd3 [commands] Redesign extension exception flow.
Instead of raising a whole variety of exceptions, they are now wrapped
into ExtensionError derived classes.

* ExtensionAlreadyLoaded
	* Raised when an extension is already loaded in Bot.load_extension
* ExtensionNotLoaded
	* Raised when an extension is not loaded, e.g. Bot.unload_extension
* NoEntryPointError
	* Raised when an extension does not have a `setup` function.
* ExtensionFailed
	* Raised when an extension's `setup` function fails.
* ExtensionNotFound
	* Raised when an extension's module import fails.
2019-03-19 09:23:11 -04:00
Rapptz
26e9b5bfac [commands] Add Bot.reload_extension for atomic loading.
Also do atomic loading in Bot.load_extension
2019-03-19 09:23:10 -04:00
Rapptz
3527203e07 [commands] Redesign HelpFormatter into HelpCommand
Part of #1938
2019-03-15 05:54:23 -04:00
Rapptz
560783c3d2 [commands] Separate view parsing errors from BadArgument.
This causes them to be raised from a new exception named
ArgumentParsingError with 3 children for ease with i18n. This is
technically a breaking change since it no longer derives from
BadArgument, though catching UserInputError will prevent this change
from affecting the user.
2019-03-12 05:27:34 -04:00
Rapptz
13b23963ec Add exception hierarchy to the documentation. 2019-03-12 01:15:24 -04:00
Rapptz
d124daef33 Fix non-working example in commands documentation. 2019-03-06 02:37:02 -05:00
Rapptz
ab8e7b7732 [commands] Fix bug in behaviour in the cog inspection methods. 2019-02-23 10:51:23 -05:00
Rapptz
caf3d17d4a Rework entire cog system and partially document it and extensions. 2019-02-23 04:10:10 -05:00
LyricLy
6bfd92e4a5 Fix is_in_guild example check 2018-11-24 23:01:46 -05:00
scragly
53c7d940c9 Outline the logic of bool converters
As a `bool` converter is treated differently from other callable (basic) converters, the explanatory docs should outline that it is evaluated differently from a simple type cast, and what logic is used in determining how the content is evaluated.
2018-11-24 22:51:17 -05:00
scragly
cec7ced1a4 Group Advanced Converters and Inline Advanced Converters
The Inline Advanced Converters are a logical extension of the Advanced Converters subject, and as such should be placed under that section without an unrelated converter type breaking the two up.
2018-11-24 22:51:16 -05:00
Rapptz
99b1390e5a [commands] Elaborate more on disallowed types in Greedy and Optional 2018-09-24 23:39:25 -04:00
Rapptz
418048b98a [commands] Fix up Greedy documentation a bit. 2018-09-24 04:22:09 -04:00
Rapptz
814b03f5a8 [commands] Add commands.Greedy converter and documentation.
This allows for greedy "consume until you can't" behaviour similar to
typing.Optional but for lists.
2018-09-24 03:56:32 -04:00
Rapptz
52767cf315 [commands] Add documentation for BadUnionArgument 2018-07-20 06:02:29 -04:00
khazhyk
2321ae8d97 [commands] raise ConversionError on Converter error
This assumes that a Converter class raising non-CommandError
is a programmer error. Makes this type of error easier to
disambiguate from a generic BadArgument.
2018-07-20 04:14:20 -04:00
Gorialis
04d9dd9c0d Change PartialReactionEmoji to PartialEmoji, add a PartialEmojiConverter 2018-01-06 17:32:25 -05:00
Tobotimus
3112e1c17e Add intersphinx 2018-01-06 17:23:59 -05:00
Rapptz
e614f6b4cd [commands] Add CategoryChannelConverter 2017-09-13 17:19:30 -04:00
ReinaSakuraba
12a371bfb8 [commands] Add MissingPermissions and BotMissingPermissions 2017-08-30 23:21:04 -04:00
Rapptz
8f0dcaa666 Variadic arguments are a tuple not a list. 2017-07-10 20:33:53 -04:00
Rapptz
2f97678a79 First pass at commands narrative documentation. 2017-07-08 00:28:23 -04:00
Rapptz
867d918e30 Add when_mentioned and when_mentioned_or to the documentation. 2017-07-01 16:18:07 -04:00