Skip to content

Commit 3aaa75e

Browse files
committed
add star arg and docstring for name
1 parent 9179e7c commit 3aaa75e

File tree

2 files changed

+5
-0
lines changed

2 files changed

+5
-0
lines changed

adafruit_led_animation/animation/comet.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@ class Comet(Animation):
4242
maximum of the length of the ``pixel_object``.
4343
:param bool reverse: Animates the comet in the reverse order. Defaults to ``False``.
4444
:param bool bounce: Comet will bounce back and forth. Defaults to ``True``.
45+
:param Optional[string] name: A human-readable name for the Animation.
46+
Used by the to string function.
4547
:param bool ring: Ring mode. Defaults to ``False``.
4648
"""
4749

adafruit_led_animation/animation/multicolor_comet.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@ class MulticolorComet(Comet):
4242
maximum of the length of the ``pixel_object``.
4343
:param bool reverse: Animates the comet in the reverse order. Defaults to ``False``.
4444
:param bool bounce: Comet will bounce back and forth. Defaults to ``True``.
45+
:param Optional[string] name: A human-readable name for the Animation.
46+
Used by the to string function.
4547
:param bool ring: Ring mode. Defaults to ``False``.
4648
:param bool off_pixels: Turn pixels off after the animation passes them. Defaults to ``True``.
4749
Setting to False will result in all pixels not currently in the comet
@@ -54,6 +56,7 @@ def __init__(
5456
pixel_object,
5557
speed,
5658
colors,
59+
*,
5760
tail_length=0,
5861
reverse=False,
5962
bounce=False,

0 commit comments

Comments
 (0)