From 0a7fe56dd261e41910aa30cb4a649e9ab28c1c13 Mon Sep 17 00:00:00 2001 From: Simon Brugman Date: Mon, 27 Jun 2022 18:12:53 +0200 Subject: [PATCH] refactor: remove outdated docs --- popmon/visualization/alert_section_generator.py | 7 ------- popmon/visualization/histogram_section.py | 2 -- popmon/visualization/section_generator.py | 5 ----- popmon/visualization/traffic_light_section_generator.py | 9 --------- 4 files changed, 23 deletions(-) diff --git a/popmon/visualization/alert_section_generator.py b/popmon/visualization/alert_section_generator.py index 94daa6b5..b0b0a122 100644 --- a/popmon/visualization/alert_section_generator.py +++ b/popmon/visualization/alert_section_generator.py @@ -55,20 +55,13 @@ def __init__( :param str read_key: key of input data to read from the datastore and use for plotting :param str store_key: key for output data to be stored in the datastore - :param str section_name: key of output data to store in the datastore :param list features: list of features to pick up from input data (optional) :param list ignore_features: ignore list of features, if present (optional) - :param int last_n: plot statistic data for last 'n' periods (optional) - :param int skip_first_n: when plotting data skip first 'n' periods. last_n takes precedence (optional) - :param int skip_last_n: in plot skip last 'n' periods. last_n takes precedence (optional) :param str static_bounds: key to static traffic light bounds key in datastore (optional) :param str dynamic_bounds: key to dynamic traffic light bounds key in datastore (optional) :param str prefix: dynamic traffic light prefix. default is ``'traffic_light_'`` (optional) :param str suffices: dynamic traffic light suffices. (optional) :param list ignore_stat_endswith: ignore stats ending with any of list of suffices. (optional) - :param bool skip_empty_plots: if false, also show empty plots in report with only nans or zeroes (optional) - :param str description: description of the section. default is empty (optional) - :param list show_stats: list of statistic name patterns to show in the report. If None, show all (optional) """ super().__init__() self.read_key = read_key diff --git a/popmon/visualization/histogram_section.py b/popmon/visualization/histogram_section.py index f6938f16..11ddc722 100644 --- a/popmon/visualization/histogram_section.py +++ b/popmon/visualization/histogram_section.py @@ -56,12 +56,10 @@ def __init__( :param str read_key: key of input data to read from the datastore and use for plotting :param str store_key: key for output data to be stored in the datastore - :param str section_name: key of output data to store in the datastore :param list features: list of features to pick up from input data (optional) :param list ignore_features: ignore list of features, if present (optional) :param list hist_names: list of histogram names to plot :param str hist_name_starts_with: find histograms in case hist_names is empty. default is histogram. - :param str description: description of the section. default is empty (optional) """ super().__init__() self.read_key = read_key diff --git a/popmon/visualization/section_generator.py b/popmon/visualization/section_generator.py index 4205f2e5..120523cb 100644 --- a/popmon/visualization/section_generator.py +++ b/popmon/visualization/section_generator.py @@ -98,17 +98,12 @@ def __init__( :param str section_name: key of output data to store in the datastore :param list features: list of features to pick up from input data (optional) :param list ignore_features: ignore list of features, if present (optional) - :param int last_n: plot statistic data for last 'n' periods (optional) - :param int skip_first_n: when plotting data skip first 'n' periods. last_n takes precedence (optional) - :param int skip_last_n: in plot skip last 'n' periods. last_n takes precedence (optional) :param str static_bounds: key to static traffic light bounds key in datastore (optional) :param str dynamic_bounds: key to dynamic traffic light bounds key in datastore (optional) :param str prefix: dynamic traffic light prefix. default is ``'traffic_light_'`` (optional) :param str suffices: dynamic traffic light suffices. (optional) :param list ignore_stat_endswith: ignore stats ending with any of list of suffices. (optional) - :param bool skip_empty_plots: if false, also show empty plots in report with only nans or zeroes (optional) :param str description: description of the section. default is empty (optional) - :param list show_stats: list of statistic name patterns to show in the report. If None, show all (optional) """ super().__init__() self.read_key = read_key diff --git a/popmon/visualization/traffic_light_section_generator.py b/popmon/visualization/traffic_light_section_generator.py index 187bd7b9..21408895 100644 --- a/popmon/visualization/traffic_light_section_generator.py +++ b/popmon/visualization/traffic_light_section_generator.py @@ -60,22 +60,13 @@ def __init__( :param str read_key: key of input data to read from the datastore and use for plotting :param str store_key: key for output data to be stored in the datastore - :param str section_name: key of output data to store in the datastore :param list features: list of features to pick up from input data (optional) :param list ignore_features: ignore list of features, if present (optional) - :param int last_n: plot statistic data for last 'n' periods (optional) - :param int skip_first_n: when plotting data skip first 'n' periods. last_n takes precedence (optional) - :param int skip_last_n: in plot skip last 'n' periods. last_n takes precedence (optional) :param str static_bounds: key to static traffic light bounds key in datastore (optional) :param str dynamic_bounds: key to dynamic traffic light bounds key in datastore (optional) :param str prefix: dynamic traffic light prefix. default is ``'traffic_light_'`` (optional) :param str suffices: dynamic traffic light suffices. (optional) :param list ignore_stat_endswith: ignore stats ending with any of list of suffices. (optional) - :param bool skip_empty_plots: if false, also show empty plots in report with only nans or zeroes (optional) - :param str description: description of the section. default is empty (optional) - :param list show_stats: list of statistic name patterns to show in the report. If None, show all (optional) - :param bool plot_overview: heatmap overview of traffic lights (features x time) - :param bool plot_metrics: individual plot per feature """ super().__init__() self.read_key = read_key