Cauldron: Documentation

Gallery Documentation

Gallery Documentation

Browse Topics

Hide Topics

Documentation

Documentation

Introduction Notebook Display Shared Variables

Introduction Notebook Display Shared Variables

Introduction UI Containers Kernel Containers UI + Kernel Containers

Introduction UI Containers Kernel Containers UI + Kernel Containers

Step Tests with unittest Step Tests with pytest

Step Tests with unittest Step Tests with pytest

Introduction Parallelism (SIMD)

Introduction Parallelism (SIMD)

API Reference

API Reference

get_environment_info refresh run_project run_server run_shell shared

get_environment_info refresh run_project run_server run_shell shared

bokeh code_block elapsed head header html image inspect jinja json latex listing list_grid markdown plotly pyplot status svg table tail text whitespace

bokeh code_block elapsed head header html image inspect jinja json latex listing list_grid markdown plotly pyplot status svg table tail text whitespace

breathe render_to_console stop visible write_to_console

breathe render_to_console stop visible write_to_console

create_test_fixture StepTestRunResult StepTestCase CauldronTest

create_test_fixture StepTestRunResult StepTestCase CauldronTest

def

listing

cauldron.display.listing()

An unordered or ordered list of the specified source iterable where each element is converted to a string representation for display.

source

list

The iterable to display as a list.

ordered

bool

Whether or not the list should be ordered. If False, which is the default, an unordered bulleted list is created.

Default Value:

False

expand_full

bool

Whether or not the list should expand to fill the screen horizontally. When defaulted to False, the list is constrained to the center view area of the screen along with other text. This can be useful to keep lists aligned with the text flow.

Default Value:

False

Copyright © 2016-2020 Scott Ernst