Skip to content

Commit 8d8b021

Browse files
committed
docs: explain ButtonPacket.pressed property values
As alluded in the __init__() docstring, explain that the "pressed" property is False when a button is released.
1 parent 330539f commit 8d8b021

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

adafruit_bluefruit_connect/button_packet.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ def button(self):
105105

106106
@property
107107
def pressed(self):
108-
"""True if button is pressed."""
108+
"""``True`` if button is pressed, or ``False`` if it is released."""
109109
return self._pressed
110110

111111

0 commit comments

Comments
 (0)