bluesky_queueserver.format_text_descriptions

bluesky_queueserver.format_text_descriptions(item_parameters, *, use_html=False)

Format parameter descriptions for a plan from the list of allowed plans. Returns description of the plan and each parameter represented as formatted strings containing plan name/description and parameter name/type/default/min/max/step/description. The text is prepared for presentation in user interfaces. The descriptions are represented as a dictionary:

{
    "description": "Multiline formatted text description of the plan",
    "parameters": {
        "param_name1": "Multiline formatted description",
        "param_name2": "Multiline formatted description",
        "param_name3": "Multiline formatted description",
    }
}

Parameters:

item_parametersdict

A dictionary of item parameters, e.g. an element from the list of existing or allowed plans.

use_htmlboolean

Select if the formatted text should be returned as plain text (default) or HTML.

Returns:

dict

The dictionary that contains formatted descriptions for the plan and its parameters.