-
Notifications
You must be signed in to change notification settings - Fork 9
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Help module #300
Merged
Merged
Help module #300
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
…dule; removed old docstrings from Questions and QuestionSetter
…re it seems to be saved to some cache/db
…cb_help in reverse
ProducerMatt
approved these changes
Jun 23, 2023
@@ -68,7 +68,7 @@ Not required: | |||
- `BOT_DEV_ROLES`: list of roles representing bot devs. | |||
- `BOT_DEV_IDS`: list of user ids of bot devs. You may want to include `BOT_VIP_IDS` here. | |||
- `BOT_CONTROL_CHANNEL_IDS`: list of channels where control commands are accepted. | |||
- `BOT_PRIVATE_CHANNEL_IDS`: single channel where private Stampy status updates are sent |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good catch! 😅
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.
closes #107 and fixes #297
HelpModule:
s, list modules
s, help <module-name>
- returns description of a module and lists all of its commandss, help <command-name>
- returns description of a commandYou can also run
python build_help.py
to buildhelp.md
from docstringsDocstrings in
utilities.help_utils.py
contain specification how docstrings should look like for parsing to work correctly.For now, I wrote them for
Questions
,QuestionSetter
,TestModule
, andHelpModule