Skip to content

Commit

Permalink
refactor: remove outdated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sbrugman committed Jun 27, 2022
1 parent fd6c9ce commit 0a7fe56
Show file tree
Hide file tree
Showing 4 changed files with 0 additions and 23 deletions.
7 changes: 0 additions & 7 deletions popmon/visualization/alert_section_generator.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 0 additions & 2 deletions popmon/visualization/histogram_section.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 0 additions & 5 deletions popmon/visualization/section_generator.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
9 changes: 0 additions & 9 deletions popmon/visualization/traffic_light_section_generator.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 0a7fe56

Please sign in to comment.