Skip to content

Commit 10659e5

Browse files
committed
Update docstrings
1 parent 293a19a commit 10659e5

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

displayio_effects/throttle_effect.py

+7-5
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
#
44
# SPDX-License-Identifier: MIT
55
"""
6-
`displayio_effects`
6+
`displayio_effects.throttle_effect`
77
================================================================================
88
9-
Add some flair to your widgets with effects!
9+
Add the throttle effect to your widgets
1010
1111
1212
* Author(s): Alec Delaney
@@ -28,7 +28,7 @@
2828

2929
@property
3030
def throttle_effect(self):
31-
"""The furtherest the throttle effect can randomly set the dial value relative
31+
"""The furtherest the throttle effect can randomly set the widget value relative
3232
to its true position, in either direction.
3333
"""
3434
return self._throttle_setting
@@ -43,15 +43,17 @@ def throttle_effect(self, setting):
4343

4444
@property
4545
def throttle_effect_move_rate(self):
46-
"""The speed at which the throttle effect moves the dial per update"""
46+
"""The speed at which the throttle effect moves the widget vaalue
47+
per update"""
48+
4749
return self._throttle_move_rate
4850

4951
@throttle_effect_move_rate.setter
5052
def throttle_effect_move_rate(self, rate):
5153
self._throttle_move_rate = rate
5254

5355
def throttle_update(self):
54-
"""Updates the gauge and propagates the throttle effect refresh"""
56+
"""Updates the widget value and propagates the throttle effect refresh"""
5557

5658
if self._throttle_setting == 0:
5759
self._throttle_destination = None

0 commit comments

Comments
 (0)