Skip to content

Commit 38af7a0

Browse files
committed
comet: add doc for background_color
Add missing documentation for the recently-added `background_color` parameter to `Comet`. Signed-off-by: Taylor Yu <[email protected]>
1 parent b101ab8 commit 38af7a0

File tree

1 file changed

+2
-0
lines changed
  • adafruit_led_animation/animation

1 file changed

+2
-0
lines changed

adafruit_led_animation/animation/comet.py

+2
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,8 @@ class Comet(Animation):
3737
:param pixel_object: The initialised LED object.
3838
:param float speed: Animation speed in seconds, e.g. ``0.1``.
3939
:param color: Animation color in ``(r, g, b)`` tuple, or ``0x000000`` hex format.
40+
:param background_color: Background color in ``(r, g, b)`` tuple, or ``0x000000`` hex format.
41+
Defaults to BLACK.
4042
:param int tail_length: The length of the comet. Defaults to 25% of the length of the
4143
``pixel_object``. Automatically compensates for a minimum of 2 and a
4244
maximum of the length of the ``pixel_object``.

0 commit comments

Comments
 (0)