adafruit-mirror/Adafruit_CircuitPython_LED_Animation
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

add star arg and docstring for name

Browse source
This commit is contained in:
foamyguy 2023-02-24 17:24:48 -06:00
parent 9179e7c25a
commit 3aaa75efbf
2 changed files with 5 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
adafruit_led_animation/animation/comet.py
View file

@ -42,6 +42,8 @@ class Comet(Animation):
maximum of the length of the ``pixel_object``. maximum of the length of the ``pixel_object``.
:param bool reverse: Animates the comet in the reverse order. Defaults to ``False``. :param bool reverse: Animates the comet in the reverse order. Defaults to ``False``.
:param bool bounce: Comet will bounce back and forth. Defaults to ``True``. :param bool bounce: Comet will bounce back and forth. Defaults to ``True``.
:param Optional[string] name: A human-readable name for the Animation.
Used by the to string function.
:param bool ring: Ring mode. Defaults to ``False``. :param bool ring: Ring mode. Defaults to ``False``.
""" """

3
adafruit_led_animation/animation/multicolor_comet.py
View file

@ -42,6 +42,8 @@ class MulticolorComet(Comet):
maximum of the length of the ``pixel_object``. maximum of the length of the ``pixel_object``.
:param bool reverse: Animates the comet in the reverse order. Defaults to ``False``. :param bool reverse: Animates the comet in the reverse order. Defaults to ``False``.
:param bool bounce: Comet will bounce back and forth. Defaults to ``True``. :param bool bounce: Comet will bounce back and forth. Defaults to ``True``.
:param Optional[string] name: A human-readable name for the Animation.
Used by the to string function.
:param bool ring: Ring mode. Defaults to ``False``. :param bool ring: Ring mode. Defaults to ``False``.
:param bool off_pixels: Turn pixels off after the animation passes them. Defaults to ``True``. :param bool off_pixels: Turn pixels off after the animation passes them. Defaults to ``True``.
Setting to False will result in all pixels not currently in the comet Setting to False will result in all pixels not currently in the comet
@ -54,6 +56,7 @@ class MulticolorComet(Comet):
pixel_object, pixel_object,
speed, speed,
colors, colors,
*,
tail_length=0, tail_length=0,
reverse=False, reverse=False,
bounce=False, bounce=False,