Merge pull request #110 from tlyu/comet-doc

comet: add doc for `background_color`
adafruit · Jan 25, 2023 · b8538c6 · b8538c6
2 parents b101ab8 + 38af7a0
commit b8538c6
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/adafruit_led_animation/animation/comet.py b/adafruit_led_animation/animation/comet.py
@@ -37,6 +37,8 @@ class Comet(Animation):
     :param pixel_object: The initialised LED object.
     :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 background_color: Background color in ``(r, g, b)`` tuple, or ``0x000000`` hex format.
+                             Defaults to BLACK.
     :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
                             maximum of the length of the ``pixel_object``.