Michael
93fa46713a
Fix and add documentation
2020-09-23 03:19:35 -04:00
Riley S
ad22fb295e
[commands] implement HelpCommand.add/remove_check
2020-08-05 21:38:58 -04:00
Sebastian Law
b4b953bfc6
Fix various inconsistencies within the documentation ( #5067 )
2020-06-28 03:45:58 -04:00
jack1142
79276da17e
Escape backslashes in display name in clean_prefix
2020-05-07 02:30:24 -04:00
Rapptz
6071607176
Bump copyright year to 2020
...
Closes #2510
2020-01-19 20:03:00 -05:00
Michael H
6cdda4a320
Patch clean_prefix for new text editor
...
The new editor seems to force mentions to have ! even without a nick.
2020-01-14 19:39:34 -05:00
StarrFox
e79ccf3f4c
[commands] check if prefix is None in .pages
2019-12-17 00:12:42 -05:00
Nelluk
dc86670d7f
Fix typo in help.py docs
...
Changed "intend" to "indent"
2019-11-26 05:16:53 -05:00
Rapptz
d4b13bd32b
[commands] Fix up Paginator documentation.
...
These aren't optional.
2019-06-29 20:29:13 -04:00
Matt (IPv4) Cowley
391ff7a486
[commands] Calculate suffix length at each add_line
2019-06-29 20:28:32 -04:00
Harmon
94c0cb0d5c
[commands] Add missing word in HelpCommand documentation
2019-06-20 22:52:47 -04:00
NCPlayz
3c9bcc2851
Improve documentation
2019-06-07 19:27:46 -04:00
Benjamin Mintz
0a0c43321b
[commands] MinimalHelpCommand: add cog description
2019-05-09 06:11:21 -04:00
Rapptz
ad5beed8dd
[commands] Copy HelpCommand instances to prevent race conditions.
...
Fixes #2123
Slight breaking change if someone had an expectation that no copies
were made behind the scene (which is sensible), however writing code
that relies on this expectation is probably buggy anyway.
2019-04-29 00:05:46 -04:00
Rapptz
919dbcafb3
Consistent use of __all__ to prevent merge conflicts.
2019-04-20 17:20:58 -04:00
Rapptz
4ca934eb22
[commands] Missing an extra ] in the documented return type.
2019-04-19 18:29:12 -04:00
Rapptz
47ab24991f
[commands] Remove extraneous or
2019-04-06 22:02:58 -04:00
Rapptz
ee81f0614e
[commands] Fix HelpCommand.invoked_with when used in events.
2019-04-06 21:33:21 -04:00
Rapptz
43b44751af
[commands] Fix MinimalHelpCommand opening note signature consistency
2019-03-24 14:46:55 -04:00
Rapptz
8c0c410d0e
[commands] Add HelpCommand.invoked_with
...
This fixes an issue where the context invoked_with does not match the
actual invoked with behaviour (e.g. using Context.send_help).
2019-03-24 14:27:37 -04:00
Rapptz
c30a366106
Try to consistently use "inherit" vs "derive" in documentation.
2019-03-19 09:23:12 -04:00
NCPlayz
fb02191b80
Organise documentation
2019-03-19 08:24:42 -04:00
slice
66af80511f
Fix pagination of huge command help messages (> ~2,000 chars)
...
Previously, calls to add_line in add_command_formatting of default help
commands would fail if the command's help message would overflow the
current page. This would also result in silent failure as the
RuntimeError raised from add_line is never caught.
This patch adds behavior that adds lines individually should it raise,
which guarantees safe pagination as long as every line is smaller than
the maximum page size, which is highly unlikely.
2019-03-16 23:24:31 -04:00
Rapptz
8466250bcc
[commands] Assign context inside HelpCommand.prepare_help_command
2019-03-16 09:24:17 -04:00
Rapptz
b728061522
[commands] Add HelpCommand.get_bot_mapping helper.
2019-03-16 09:23:34 -04:00
Rapptz
7a5102ece9
[commands] Return result of send_group_help and send_command_help
2019-03-16 07:33:12 -04:00
Rapptz
61f63a9346
[commands] Add back dm_help tribool for the provided HelpCommands
...
Also add a dm_help_threshold integer to control the length.
2019-03-16 03:50:30 -04:00
Rapptz
25acad5de3
[commands] Add commands.Paginator.__len__
2019-03-16 03:38:51 -04:00
Rapptz
3527203e07
[commands] Redesign HelpFormatter into HelpCommand
...
Part of #1938
2019-03-15 05:54:23 -04:00
