Skip to content

Add optional docs_info str to task models #874

@jluethi

Description

@jluethi

We should add a docs_info str to the task models. The purpose is that developers can specify a single, markdown formatted string that describes the functionality of their task. This is useful to show under the info button on the task page (public & in Fractal servers). If it's filled out, the docs_info entry in the manifest is filled with that.

Screenshot 2024-12-13 at 10 14 34

Currently, we just show the task docstring as docs_info. We could just improve docstrings to become more user-friendly. But sometimes developers want dev-related info in the docstrings.
Plus, having a single docs_info field in the task models that's filled in the task list will allow us to provide a single summary for compound tasks, instead of combining the docstrings.

Screenshot 2024-12-13 at 10 14 20

Given how these info panels are currently displayed, the content of docs_info can be multiple sentences without an issue.

Screenshot 2024-12-13 at 10 20 02

If we can also adapt to not show the titles quite so large or not default to setting titles based on docstring info parsed at all, that would further help clean up the interface

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Status

    Done

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions