You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Currently the docstring of (e.g.) enum parameters is dumped on to the UI as one long string. This makes it hard to self-document flow parameters for people running flows.
Example:
frompydanticimportBaseModelfromprefectimportflowclassBadParams(BaseModel):
"""This is a realllllly long description that should be rendered as markdown Attributes: a: This is a really long description that should be rendered as markdown b: This is a really long description that should be rendered as markdown c: This is a really long description that should be rendered as markdown x: This is a really long description that should be rendered as markdown y: This is a really long description that should be rendered as markdown z: This is a really long description that should be rendered as markdown """a: intb: intc: intx: inty: intz: int@flowdefbad_params_render(params: BadParams):
passif__name__=="__main__":
bad_params_render.serve()
Describe the proposed behavior
Support some sort of formatting, Markdown would be the obvious choice, to allow flow developers to nicely format this text.
Describe the current behavior
Currently the docstring of (e.g.) enum parameters is dumped on to the UI as one long string. This makes it hard to self-document flow parameters for people running flows.
Example:
Describe the proposed behavior
Support some sort of formatting, Markdown would be the obvious choice, to allow flow developers to nicely format this text.
Example Use
No response
Additional context
Prefect slack thread from 2024-09-13:
https://prefect-community.slack.com/archives/C0192RWGJQH/p1726235752005299
The text was updated successfully, but these errors were encountered: