Customizing Your Interface
Workflow Documentation
While most of the metadata of a workflow will be encapsulated in a LatchMetadata object, we still require a docstring in the body of the workflow function which specifies both a short and long-form description.
Short Description
The workflow sidebar and workflow explore tab render the first line of the workflow docstring as a brief description of its functionality. This description should summarize the significance of the workflow in a single line.
Long Description
The body of the workflow function docstring supports GitHub-flavored markdown and KaTeX, a subset of LaTeX for mathematical typesetting.
The workflow “About” tab renders all lines of the workflow docstring after the first. This should include any long-form documentation for the workflow.
Was this page helpful?