Closed MatthewBaggins closed 1 year ago
closes #107 and fixes #297
HelpModule:
s, list modules
s, help <module-name>
s, help <command-name>
You can also run python build_help.py to build help.md from docstrings
python build_help.py
help.md
Docstrings in utilities.help_utils.py contain specification how docstrings should look like for parsing to work correctly.
utilities.help_utils.py
For now, I wrote them for Questions, QuestionSetter, TestModule, and HelpModule
Questions
QuestionSetter
TestModule
HelpModule
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