markdown

Parameter.markdown(all_parameters: Parameters | None = None, initial_parameters: Parameters | None = None) MarkdownStr[source]

Get a markdown representation of the parameter.

Parameters:
  • all_parameters (Parameters | None) – A parameter group containing the whole parameter set (used for expression lookup).

  • initial_parameters (Parameters | None) – The initial parameter.

Returns:

The parameter as markdown string.

Return type:

MarkdownStr