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

comet: add doc for background_color

Browse source 
Add missing documentation for the recently-added `background_color`
parameter to `Comet`.

Signed-off-by: Taylor Yu <code@argon.blue>
This commit is contained in:
Taylor Yu 2023-01-24 22:39:55 -06:00
parent b101ab80e8
commit 9ace6f7ad9
1 changed files with 1 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
adafruit_led_animation/animation/comet.py
View file

@ -37,6 +37,7 @@ class Comet(Animation):
:param pixel_object: The initialised LED object. :param pixel_object: The initialised LED object.
:param float speed: Animation speed in seconds, e.g. ``0.1``. :param float speed: Animation speed in seconds, e.g. ``0.1``.
:param color: Animation color in ``(r, g, b)`` tuple, or ``0x000000`` hex format. :param color: Animation color in ``(r, g, b)`` tuple, or ``0x000000`` hex format.
:param background_color: Background color in ``(r, g, b)`` tuple, or ``0x000000`` hex format.
:param int tail_length: The length of the comet. Defaults to 25% of the length of the :param int tail_length: The length of the comet. Defaults to 25% of the length of the
``pixel_object``. Automatically compensates for a minimum of 2 and a ``pixel_object``. Automatically compensates for a minimum of 2 and a
maximum of the length of the ``pixel_object``. maximum of the length of the ``pixel_object``.