show_parameters_definition

Project.show_parameters_definition(parameters_name: str, syntax: str | None = None, *, as_dataframe: bool | None = None) → MarkdownStr | DataFrame[source]

Show parameters definition file content with syntax highlighting.

Parameters:

  • parameters_name (str) – The name of the parameters.

  • syntax (str | None) – Syntax used for syntax highlighting. Defaults to None which means that the syntax is inferred based on the file extension. Pass the value "" to deactivate syntax highlighting.

  • as_dataframe (bool | None) – Whether or not to show the Parameters definition as pandas.DataFrame (mostly useful for non string formats). Defaults to None which means that it will be inferred to True for known non string formats like xlsx.

Returns:

Parameters definition file content with syntax highlighting to render in ipython.

Return type:

MarkdownStr | pd.DataFrame