Skip to content

Commit 1eb28a2

Browse files
committed
docs: add usage examples to formatter functions in html_formatter.py
1 parent eb1fac4 commit 1eb28a2

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

python/datafusion/html_formatter.py

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -454,6 +454,11 @@ def get_formatter() -> DataFrameHtmlFormatter:
454454
455455
Returns:
456456
The global HTML formatter instance
457+
458+
Example:
459+
>>> from datafusion.html_formatter import get_formatter
460+
>>> formatter = get_formatter()
461+
>>> formatter.max_cell_length = 50 # Increase cell length
457462
"""
458463
return _default_formatter
459464

@@ -467,6 +472,15 @@ def configure_formatter(**kwargs: Any) -> None:
467472
Args:
468473
**kwargs: Formatter configuration parameters like max_cell_length,
469474
max_width, max_height, enable_cell_expansion, etc.
475+
476+
Example:
477+
>>> from datafusion.html_formatter import configure_formatter
478+
>>> configure_formatter(
479+
... max_cell_length=50,
480+
... max_height=500,
481+
... enable_cell_expansion=True,
482+
... use_shared_styles=True
483+
... )
470484
"""
471485
global _default_formatter
472486
_default_formatter = DataFrameHtmlFormatter(**kwargs)
@@ -480,6 +494,10 @@ def reset_formatter() -> None:
480494
481495
This function creates a new formatter with default configuration
482496
and sets it as the global formatter for all DataFrames.
497+
498+
Example:
499+
>>> from datafusion.html_formatter import reset_formatter
500+
>>> reset_formatter() # Reset formatter to default settings
483501
"""
484502
global _default_formatter
485503
_default_formatter = DataFrameHtmlFormatter()
@@ -496,6 +514,10 @@ def reset_styles_loaded_state() -> None:
496514
497515
This can be useful when switching between notebook sessions or
498516
when styles need to be refreshed.
517+
518+
Example:
519+
>>> from datafusion.html_formatter import reset_styles_loaded_state
520+
>>> reset_styles_loaded_state() # Force styles to reload in next render
499521
"""
500522
DataFrameHtmlFormatter._styles_loaded = False
501523

0 commit comments

Comments
 (0)