Skip to content

Add argument descriptions to display() #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rickwporter merged 1 commit into from
Feb 21, 2026
Merged

Add argument descriptions to display() #13

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion rich_objects/display.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
Loading