ui icon indicating copy to clipboard operation
ui copied to clipboard

Feature Request: Instructions/Descriptions for Parameters in UI

Open marvin-robot opened this issue 3 years ago • 1 comments

Opened from the Prefect Public Slack Community

williamjamir: Its possible to add some labels or instructions for parameters input? In my case I would to like to add some instructions about the “date_from” parameter, allowed values and so on.

kevin701: There is a request for this already but the answer is not at the moment

williamjamir: Do you have the link for the GitHub issue to track this? I tried to find it here but had no success =/

kevin701: Oh my bad. I think I was thinking about https://github.com/PrefectHQ/ui/issues/1189|this. We can make a new one for this. <@ULVA73B9P> open “Feature Request: Instructions/Descriptions for Parameters in UI” in UI

Original thread can be found here.

marvin-robot avatar Jun 29 '22 16:06 marvin-robot

My idea is to be able to document/describe parameters, and this description be visible in the UI. Something like:

config_id = Parameter(
    name='config_id', 
    required=True,
    description="Some helpful message to be displayed over the Dashboard as a label or callout"    
)

williamjamir avatar Jun 29 '22 18:06 williamjamir