Documentation for Config module (i.e. "tp.config" functions) is incomplete #1325
Labels
documentation
Improvements or additions to documentation
good first issue
A good issue for someone who wants to contribute
Plugin information (please complete the following information):
n.a.
Describe the bug
The documentation for the functions in the config module is missing essential information.
E.g. for
tp.config.run_mode
, the description says that it returns aRunMode
.What is the type of this parameter? What are the values that it returns?
Also, there are no examples from which this information could be deduced.
Expected behavior
Concise explanation of parameter types, possible return values and at leats one actual usage example per function
Screenshots
n.a.
Additional context
n.a.
The text was updated successfully, but these errors were encountered: