Example from an inbuilt job - I’d love to be able to edit this page a bit to give more details. If someone installs a plugin designed to e.g. do PID pH control, it’s useful for the documentation to be right there
Yea I agree, this view is too terse, and there’s no way to learn more.
Are you thinking of
- taking the “comments” from config.ini parameters and displaying them beside each field?
- Link to external documentation
- Some other “editable” metadata / yaml / file?
A YAML sets these in the first place, right? I think adding description there would probably be best. Comments in config can be easily deleted by the user. Then the author can decide if they want to add links to external documentation
these fields are pulled from the config.ini infact, from the [<job_name>.config] section.
Comments in config can be easily deleted by the user.
Yes, they can be, hmm
Oh right, my bad yes. I guess it called also be pulled using some structure like a docstring/comments in the code for the job, which is less user-facing