From 982c5a6edf68f03c8fd339a56058948870113a89 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tobias=20Pl=C3=BCcker?= Date: Fri, 12 Jul 2024 22:48:09 +0200 Subject: [PATCH] theme parameter documented --- src/safeds/data/tabular/plotting/_column_plotter.py | 7 +++++++ src/safeds/data/tabular/plotting/_table_plotter.py | 5 +++++ 2 files changed, 12 insertions(+) diff --git a/src/safeds/data/tabular/plotting/_column_plotter.py b/src/safeds/data/tabular/plotting/_column_plotter.py index 8847d1849..03b44c3ed 100644 --- a/src/safeds/data/tabular/plotting/_column_plotter.py +++ b/src/safeds/data/tabular/plotting/_column_plotter.py @@ -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: @@ -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 ------- diff --git a/src/safeds/data/tabular/plotting/_table_plotter.py b/src/safeds/data/tabular/plotting/_table_plotter.py index 5ddcca1bf..fa9243704 100644 --- a/src/safeds/data/tabular/plotting/_table_plotter.py +++ b/src/safeds/data/tabular/plotting/_table_plotter.py @@ -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: