Skip to content

Commit 8a436b5

Browse files
committed
correct docstring for IconAnimation.init_class, thanks foamyguy
1 parent 25098ec commit 8a436b5

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

adafruit_displayio_layout/widgets/icon_animated.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ class IconAnimated(IconWidget):
3838
OnDiskBitmap and a text label centered beneath it. Includes optional
3939
animation to increase the icon size when pressed.
4040
41-
.. Warning:: The `init_class` class function should be called before instancing any
41+
.. Warning:: The `init_class` class function must be called before instancing any
4242
IconAnimated widgets.
4343
4444
:param str label_text: the text that will be shown beneath the icon image.
@@ -81,9 +81,9 @@ def init_class(
8181
Initializes the IconAnimated Class variables, including preallocating memory
8282
buffers for the icon zoom bitmap and icon palette.
8383
84-
.. Note:: The `init_class` class function should be called before instancing any
84+
.. Note:: The `init_class` class function must be called before instancing any
8585
IconAnimated widgets. Usage example:
86-
``IconAnimated(display=board.DISPLAY, max_scale=1.5,
86+
``IconAnimated.init_class(display=board.DISPLAY, max_scale=1.5,
8787
max_size=(80,80), max_color_depth=256)``
8888
8989
:param displayio.Display display: The display where the icons will be displayed.

0 commit comments

Comments
 (0)