##// END OF EJS Templates
Add docstring documentation for widget_float
Silvia -
Show More
@@ -55,6 +55,26 b' class BoundedFloatText(_BoundedFloat):'
55
55
56 @register('IPython.FloatSlider')
56 @register('IPython.FloatSlider')
57 class FloatSlider(_BoundedFloat):
57 class FloatSlider(_BoundedFloat):
58 """ Slider/trackbar of floating values with the specified range.
59
60 Parameters
61 ----------
62 value : float
63 initial position of the slider
64 min : float
65 minimal position of the slider
66 max : float
67 maximal position of the slider
68 step : float
69 step of the trackbar
70 description : str
71 name of the slider
72 orientation : {'vertical', 'horizontal}, optional
73 default is horizontal
74 readout : {True, False}, optional
75 default is True, display the current value of the slider next to it
76
77 """
58 _view_name = Unicode('FloatSliderView', sync=True)
78 _view_name = Unicode('FloatSliderView', sync=True)
59 orientation = CaselessStrEnum(values=['horizontal', 'vertical'],
79 orientation = CaselessStrEnum(values=['horizontal', 'vertical'],
60 default_value='horizontal',
80 default_value='horizontal',
@@ -66,6 +86,22 b' class FloatSlider(_BoundedFloat):'
66
86
67 @register('IPython.FloatProgress')
87 @register('IPython.FloatProgress')
68 class FloatProgress(_BoundedFloat):
88 class FloatProgress(_BoundedFloat):
89 """ Progress bar.
90
91 Parameters
92 -----------
93 value : float
94 current position within the range of the progress bar
95 min : float
96 minimal position of the slider
97 max : float
98 maximal position of the slider
99 step : float
100 step of the progress bar
101 description : str
102 name of the progress bar
103
104 """
69 _view_name = Unicode('ProgressView', sync=True)
105 _view_name = Unicode('ProgressView', sync=True)
70
106
71 bar_style = CaselessStrEnum(
107 bar_style = CaselessStrEnum(
General Comments 0
You need to be logged in to leave comments. Login now