From 7f683122988c950a23503e291866bf464aeaeac1 Mon Sep 17 00:00:00 2001 From: Rick Porter Date: Sat, 21 Feb 2026 10:00:15 -0500 Subject: [PATCH] Add argument descriptions to display() --- rich_objects/display.py | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/rich_objects/display.py b/rich_objects/display.py index 3f65c3d..c3d3add 100755 --- a/rich_objects/display.py +++ b/rich_objects/display.py @@ -239,7 +239,18 @@ def display( console: Optional[Console] = None, config: Optional[TableConfig] = None, ) -> None: - """Display the data provided in obj, according to the formating arguments.""" + """Display the data provided in obj, according to the formating arguments. + + Arguments: + obj: object to be displayed + fmt: controls the json/table/yaml output formatting (default=table) + style: controls color/bold highlighting (default=all) + indent: conroles number of indented spaces in json/yaml output (default=2) + columns: used to control columns for a list of items, use a '*' as last argument to get remaining data. + console: overrides default rich.Console, so you can provide additional highlighers. + config: controls table parameters (e.g. labels, max-widths, row properties) + + """ no_color = style != OutputStyle.ALL highlight = style != OutputStyle.NONE console = console or console_factory(no_color=no_color, highlight=highlight)