Skip to content

Commit

Permalink
theme parameter documented
Browse files Browse the repository at this point in the history
  • Loading branch information
TobiasPluecker committed Jul 12, 2024
1 parent 02ce0fe commit 982c5a6
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 0 deletions.
7 changes: 7 additions & 0 deletions src/safeds/data/tabular/plotting/_column_plotter.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,11 @@ def box_plot(self, *, theme: Literal["dark", "light"] = "light") -> Image:
"""
Create a box plot for the values in the column. This is only possible for numeric columns.
Parameters
----------
theme:
The theme to use for the plot. Either "dark" or "light".
Returns
-------
plot:
Expand Down Expand Up @@ -169,6 +174,8 @@ def lag_plot(self, lag: int, *, theme: Literal["dark", "light"] = "light") -> Im
----------
lag:
The amount of lag.
theme:
The theme for the plot, either "dark" or "light". Default is "light
Returns
-------
Expand Down
5 changes: 5 additions & 0 deletions src/safeds/data/tabular/plotting/_table_plotter.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,11 @@ def box_plots(self, *, theme: Literal["dark", "light"] = "light") -> Image:
"""
Create a box plot for every numerical column.
Parameters
----------
theme:
The theme to use for the plot. Either "dark" or "light".
Returns
-------
plot:
Expand Down

0 comments on commit 982c5a6

Please sign in to comment.