Skip to content

Commit 11a570c

Browse files
committed
Second Documentation Pass
1 parent 86c6491 commit 11a570c

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

adafruit_button/button_base.py

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
pass
3232

3333

34-
def _check_color(color: Optional[Union[int, tuple[int, int, int]]]) -> Optional[int]:
34+
def _check_color(color: Optional[Union[int, tuple[int, int, int]]]) -> int:
3535
# if a tuple is supplied, convert it to a RGB number
3636
if isinstance(color, tuple):
3737
r, g, b = color
@@ -47,14 +47,13 @@ class ButtonBase(Group):
4747
:param int y: The y position of the button.
4848
:param int width: The width of the button in tiles.
4949
:param int height: The height of the button in tiles.
50-
:param str name: A name, or miscellaneous string that is stored on the button.
51-
:param str label: The text that appears inside the button.
52-
:param FontProtocol label_font: The button label font. Defaults to ''terminalio.FONT''
53-
:param int|Tuple(int, int, int) label_color: The color of the button label text.
54-
Accepts an int or a tuple of 3 integers representing RGB values. Defaults to 0x0.
55-
:param int|Tuple(int, int, int) selected_label: The color of button label text when the button is selected.
50+
:param Optional[str] name: A name, or miscellaneous string that is stored on the button.
51+
:param Optional[str] label: The text that appears inside the button.
52+
:param Optional[FontProtocol] label_font: The button label font. Defaults to ''terminalio.FONT''
53+
:param Optional[int] label_color: The color of the button label text. Defaults to 0x0.
54+
:param Optional[Union[int, Tuple[int, int, int]]] selected_label: The color of button label text when the button is selected.
5655
Accepts an int or a tuple of 3 integers representing RGB values. Defaults to an inverse of label_color.
57-
:param int label_scale: The scale factor used for the label. Defaults to 1.
56+
:param Optional[int] label_scale: The scale factor used for the label. Defaults to 1.
5857
"""
5958

6059
def __init__(

0 commit comments

Comments
 (0)