From 1ee380fddff25827d40b365ef02ac0a7d7259699 Mon Sep 17 00:00:00 2001 From: jh777916 Date: Tue, 10 Oct 2023 10:20:47 +0200 Subject: [PATCH] Modification of some docstrings --- .../src/python/controller/PlotController.py | 25 ++++++++++++++++--- 1 file changed, 22 insertions(+), 3 deletions(-) diff --git a/tools/CurvePlot/src/python/controller/PlotController.py b/tools/CurvePlot/src/python/controller/PlotController.py index f56fe61f1..c2a619fd7 100644 --- a/tools/CurvePlot/src/python/controller/PlotController.py +++ b/tools/CurvePlot/src/python/controller/PlotController.py @@ -193,8 +193,17 @@ class PlotController(object): @classmethod def AddBarPlot(cls, x_ticks, height, curve_label="", x_label="", y_label="", append=True): - """ Testing some stuff with BarPlot""" - + """ Add a new barplot and make the plot set where it is drawn the active one. + If no plot set exists, or none is active, a new plot set will be created, even if append is True. + @param x_ticks array of ticks along the X axis + @param height array of value representing the data ( size(height) = size(x_ticks)-1 ) + @param curve_label label of the curve being ploted (optional, default to empty string). This is what is + shown in the legend. + @param x_label label for the X axis + @param y_label label for the Y axis + @param append whether to add the curve to the active plot set (default) or into a new one. + @return the id of the created curve, and the id of the corresponding plot set. + """ from .XYView import XYView control = cls.GetInstance() pm = control._plotManager @@ -222,7 +231,17 @@ class PlotController(object): @classmethod def AddStemPlot(cls, x, y, curve_label="", x_label="", y_label="", append=True): - """ Testing some stuff with StemPlot""" + """ Add a new stemplot and make the plot set where it is drawn the active one. + If no plot set exists, or none is active, a new plot set will be created, even if append is True. + @param x x data + @param y y data + @param curve_label label of the curve being ploted (optional, default to empty string). This is what is + shown in the legend. + @param x_label label for the X axis + @param y_label label for the Y axis + @param append whether to add the curve to the active plot set (default) or into a new one. + @return the id of the created curve, and the id of the corresponding plot set. + """ from .XYView import XYView control = cls.GetInstance() -- 2.39.2