maintenance_tasks icon indicating copy to clipboard operation
maintenance_tasks copied to clipboard

Support attribute descriptions

Open gmac opened this issue 4 years ago • 2 comments

When defining attributes, it would be extremely useful if supporting descriptions could also be specified. These supporting descriptions would be included in the web UI with each attribute input field, and could provide some instructions about what the attribute does and what it's possible values and uses are.

gmac avatar Aug 25 '21 14:08 gmac

Hey @gmac ! The task source code is included in the UI - why not just add a comment above each attribute with a description / acceptable values, etc?

adrianna-chang-shopify avatar Aug 25 '21 16:08 adrianna-chang-shopify

Thanks for the reply! I have indeed done that for starters, but am fielding repeated inquiries from team members about how the job attributes work. It seems that we're not naturally trained to look in code snippets for documentation.

Anywho – nothing is broken, this would just be a very nice-to-have to make the job form self-documenting.

gmac avatar Aug 25 '21 17:08 gmac

This issue has been marked as stale because it has not been commented on in two months. Please reply in order to keep the issue open. Otherwise, it will close in 14 days. Thank you for contributing!

github-actions[bot] avatar Jan 27 '24 01:01 github-actions[bot]