CheckResult.show#
- CheckResult.show(as_widget: bool = True, unique_id: Optional[str] = None, show_additional_outputs: bool = True, **kwargs) Optional[HTMLFormatter][source]#
Display the check result.
- Parameters
- as_widgetbool, default True
whether to use ipywidgets or not
- unique_idOptional[str], default None
unique identifier of the result output
- show_additional_outputsbool, default True
whether to show additional outputs or not
- Returns
- Optional[HTMLFormatter]
when used by sphinx-gallery