param_dict_to_markdown

glotaran.parameter.parameters.param_dict_to_markdown(parameters: dict | list, float_format: str = '.3e', depth: int = 0, label: str | None = None) MarkdownStr[source]

Format the Parameters as markdown string.

This is done by recursing the nested Parameters tree.

Parameters:
  • parameters (dict | list) – The parameter dict or list.

  • float_format (str) – Format string for floating point numbers, by default “.3e”

  • depth (int) – The depth of the parameter dict.

  • label (str | None) – The label of the parameter dict.

Returns:

The markdown representation as string.

Return type:

MarkdownStr