3260ec6643
Add improved docs for slash commands ( #77 )
...
* Fix command checks actually working
* Current progress on slash command docs
* Improve docs for slash commands further
2021-09-27 01:14:07 -07:00
1c63816cc0
[commands] Document / type-hint cooldown
2021-08-10 08:35:15 -04:00
ec32b71ff9
[commands] Document GuildNotFound
2021-08-10 08:34:11 -04:00
c628224403
[commands] Add GuildStickerConverter
2021-08-10 08:31:20 -04:00
3ad95f3746
[commands] Document dynamic_cooldown
2021-07-30 21:29:40 -04:00
3cb539d91b
[commands] Document the thread converter
2021-07-07 20:15:18 -04:00
b2c9c26841
Show decorator usage instead of signature in docs
2021-06-27 23:40:39 -04:00
2a6d79078e
[commands] Add GuildChannelConverter
2021-05-07 07:37:42 -04:00
3864fb37a0
Fix various reference issues in documentation
...
Co-Authored-By: Riley Shaw <30989490+ShineyDev@users.noreply.github.com >
2021-05-06 07:51:07 -04:00
18bf3d3a7d
[commands] Actually expose the FlagError base error
2021-04-19 10:27:24 -04:00
ddb71e2aed
[commands] Initial support for FlagConverter
...
The name is currently pending and there's no command.signature hook
for it yet since this requires bikeshedding.
2021-04-19 10:25:08 -04:00
c54e43360b
[commands] Add run_converters helper to call converters
2021-04-19 04:46:02 -04:00
5dec62f4c0
[commands] Add a converter for discord.Object
2021-04-16 08:18:57 -04:00
42c3ee6eed
Bring back discord module in discord.ext.commands documentation
2021-04-10 15:49:39 -04:00
296bd069c1
Remove current module reference in commands API docs
2021-04-10 14:59:26 -04:00
b20e92efd8
[docs] Fix references to Greedy
2021-04-10 14:59:09 -04:00
bcd3a00eaf
[commands] Make commands.Greedy a typing.Generic
2021-04-10 07:27:32 -04:00
05c123f3ab
Use f-strings in more places that were missed
2021-04-08 09:31:06 -04:00
e895a53713
[commands] Add StageChannelConverter to documentation
2021-04-08 00:44:47 -04:00
f6df66a971
Add missing documentation for StoreChannelConverter
2021-04-04 00:21:15 -04:00
68eb844d48
[commands] Add discord.Guild converter and GuildNotFound error
...
* Add discord.Guild converter and GuildNotFound error
* note for lack of disambiguation in Guilds with duplicate names, and removed the possibility of returning None
* edited converter to use `utils.get` over `utils.find` and docs edited with Converter and Exception.
2021-02-07 05:32:33 -05:00
e0e60a2f62
[commands] document PartialMessageConverter
2021-01-24 05:16:32 -05:00
116fdbddb9
[commands] Fix exception hierarchy documentation
2020-12-22 04:23:37 -05:00
17b49c5a46
[commands] Make documentation use new attributetable
2020-12-18 21:35:27 -05:00
367c4b5fd2
[docs] remove unresolved doc refs, fix attribute ref
2020-09-07 22:25:11 -04:00
0a7e2f7c2f
[commands] BadBooleanArgument -> BadBoolArgument
2020-09-04 08:47:07 -04:00
6ebd2e13a1
[commands] Add subclasses of BadArgument for converters
2020-09-04 08:45:29 -04:00
84098ed824
[commands] Add a new exception class for command registration errors
2020-06-28 03:48:07 -04:00
b4b953bfc6
Fix various inconsistencies within the documentation ( #5067 )
2020-06-28 03:45:58 -04:00
1b0e806245
[commands] Implement commands.before/after_invoke
2020-04-04 02:57:20 -04:00
2ba28bbfe2
One last superfluous .0 in versionadded
2020-01-22 21:12:02 -05:00
d9cd4a3561
[commands] Implement Command.__call__
2020-01-21 04:27:20 -05:00
4de314d2c3
[commands] Export max_concurrency and MaxConcurrencyReached in docs
2020-01-21 03:35:43 -05:00
a2b241446e
[commands] Document BucketType separately
2020-01-18 20:04:00 -05:00
82797b0e60
[commands] Add missing CheckAnyFailure documentation
2020-01-14 19:54:10 -05:00
92a3c1b583
[commands] Document guild permission checks
2020-01-07 04:50:52 -05:00
ae3dac0d59
[commands] Add check_any check to OR together various checks
2020-01-06 22:03:56 -05:00
7543328fe7
Update Sphinx to 2.1.2
2019-06-28 01:43:04 -04:00
3c9bcc2851
Improve documentation
2019-06-07 19:27:46 -04:00
f8cc64ca7e
Add changelog for v1.1.0
2019-05-10 20:19:51 -04:00
bb3ebc0ebc
[commands] Add custom exception classes for built-in checks
...
Added:
* MissingRole
* BotMissingRole
* MissingAnyRole
* BotMissingAnyRole
2019-04-20 16:45:37 -04:00
440db2a568
[commands] Add MessageConverter to fetch messages by URL or ID.
2019-04-17 20:47:21 -04:00
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
3527203e07
[commands] Redesign HelpFormatter into HelpCommand
...
Part of #1938
2019-03-15 05:54:23 -04:00
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
13b23963ec
Add exception hierarchy to the documentation.
2019-03-12 01:15:24 -04:00
caf3d17d4a
Rework entire cog system and partially document it and extensions.
2019-02-23 04:10:10 -05:00
99b1390e5a
[commands] Elaborate more on disallowed types in Greedy and Optional
2018-09-24 23:39:25 -04:00
418048b98a
[commands] Fix up Greedy documentation a bit.
2018-09-24 04:22:09 -04:00
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
