Add basic tutorial for HelpCommand. #2017
Draft
+268
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
laggycomputer
suggested changes
Mar 22, 2019
Rapptz
requested changes
Mar 23, 2019
docs/ext/commands/help.rst
Outdated
| ================= | ||
|
|
||
| The simplicity of :class:`~.commands.HelpCommand` allows you to customise | ||
| your experience very easily. |
There was a problem hiding this comment.
This sentence seems like it belongs somewhere explaining how to do custom commands. Which... this does not do. Probably re-order the entire structure. To something like this:
- Using The Help Command
- Probably talk about the interface of the actual help command
show examples etc - Talk about the sending help with ctx here
- Probably talk about the interface of the actual help command
- Replacing The Help Command
- Talk about how you can set
bot.help_command- This would be a good time to show
commands.MinimalHelpCommand
- This would be a good time to show
- Talk about how you can do
bot.help_command.cog = ...
- Talk about how you can set
- Writing A Help Command
- Talk about the steps to write your own custom help
- Describe all of the member functions required to make a help command and walk through the steps together
This is what I had in mind as a rough idea. Documentation of prose pages requires planning and working with flow so the contents are coherent instead of random paragraphs.
84b17a0
to
1db966b
Compare
Co-authored-by: James <[email protected]>
071c797
to
c4f52fc
Compare
|
what happened to this? |
|
It will be left until the help command redesign is finished |
|
Is this still being worked on? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR was made to add a tutorial for HelpCommand and the like. I'm sure there's many issues with this, but I just wanted to get this out so that it can be reviewed, and so that I can improve it.
Checklist
Update
03/04/2019 20:14 : This probably won't get done for at least another week. Sorry!