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

Documentation for Config module (i.e. "tp.config" functions) is incomplete #1325

Open
workflowsguy opened this issue Feb 18, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue A good issue for someone who wants to contribute

Comments

@workflowsguy
Copy link

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 a RunMode.
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.

@workflowsguy workflowsguy added the bug Something isn't working label Feb 18, 2024
@Zachatoo Zachatoo added documentation Improvements or additions to documentation good first issue A good issue for someone who wants to contribute and removed bug Something isn't working labels Feb 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue A good issue for someone who wants to contribute
Projects
None yet
Development

No branches or pull requests

2 participants