diff options
| author | Ben Reynwar <ben@reynwar.net> | 2012-08-14 07:12:53 -0700 |
|---|---|---|
| committer | Ben Reynwar <ben@reynwar.net> | 2012-08-14 07:22:43 -0700 |
| commit | 3e46aef392ba9b2e63bbfefefdb7178cc87049ab (patch) | |
| tree | 942e3a7a78344b638859b9f65ce37cacb070eb01 /gr-wxgui/src/python/plotter/bar_plotter.py | |
| parent | fe96ee8d82b2666951cf3cef8f7f5d991396273f (diff) | |
docs: Changed arguments in python docstrings to new formatting style.
Diffstat (limited to 'gr-wxgui/src/python/plotter/bar_plotter.py')
| -rw-r--r-- | gr-wxgui/src/python/plotter/bar_plotter.py | 18 |
1 files changed, 12 insertions, 6 deletions
diff --git a/gr-wxgui/src/python/plotter/bar_plotter.py b/gr-wxgui/src/python/plotter/bar_plotter.py index 3f9259e9df..487db66b64 100644 --- a/gr-wxgui/src/python/plotter/bar_plotter.py +++ b/gr-wxgui/src/python/plotter/bar_plotter.py @@ -108,9 +108,13 @@ class bar_plotter(grid_plotter_base): Get the text the will populate the point label. Give X and Y values for the current point. Give values for the channel at the X coordinate. - @param x_val the current x value - @param y_val the current y value - @return a string with newlines + + Args: + x_val: the current x value + y_val: the current y value + + Returns: + a string with newlines """ if len(self._bars) == 0: return '' scalar = float(len(self._bars)-1)/(self.x_max - self.x_min) @@ -130,9 +134,11 @@ class bar_plotter(grid_plotter_base): def set_bars(self, bars, bar_width, color_spec): """ Set the bars. - @param bars a list of bars - @param bar_width the fractional width of the bar, between 0 and 1 - @param color_spec the color tuple + + Args: + bars: a list of bars + bar_width: the fractional width of the bar, between 0 and 1 + color_spec: the color tuple """ self.lock() self._bars = bars |