Skip to content
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 28 commits into from
Jun 23, 2023
Merged

Help module #300

merged 28 commits into from
Jun 23, 2023

Conversation

MatthewBaggins
Copy link
Collaborator

@MatthewBaggins MatthewBaggins commented Jun 23, 2023

closes #107 and fixes #297

HelpModule:

  • List modules
    • s, list modules
  • Help - (1) a particular module or (2) a particular command defined on a module
    • s, help <module-name> - returns description of a module and lists all of its commands
    • s, help <command-name> - returns description of a command

You can also run python build_help.py to build help.md from docstrings

Docstrings 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, and HelpModule

Mateusz Bagiński added 28 commits June 22, 2023 16:04
…dule; removed old docstrings from Questions and QuestionSetter
@@ -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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch! 😅

@ProducerMatt ProducerMatt merged commit f760816 into master Jun 23, 2023
@ProducerMatt ProducerMatt deleted the help-module branch August 13, 2023 23:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

question_setter module firing at unwanted times Help module
2 participants