Document Button default values

This commit is contained in:
Andrew Scheller
2016-06-06 03:46:32 +01:00
parent 8b81057f8b
commit c1c9bcebee

View File

@@ -256,11 +256,13 @@ class Button(HoldMixin, DigitalInputDevice):
:param float hold_time:
The length of time (in seconds) to wait after the button is pushed,
until executing the :attr:`when_held` handler.
until executing the :attr:`when_held` handler. Defaults to ``1``.
:param bool hold_repeat:
If ``True``, the :attr:`when_held` handler will be repeatedly executed
as long as the device remains active, every *hold_time* seconds.
as long as the device remains active, every *hold_time* seconds. If
``False`` (the default) the :attr:`when_held` handler will be only be
executed once per hold.
"""
def __init__(
self, pin=None, pull_up=True, bounce_time=None,