Skip to content

Commit 2248b4f

Browse files
committed
Update tail length documentation.
1 parent 87c1f17 commit 2248b4f

File tree

1 file changed

+3
-8
lines changed
  • adafruit_led_animation/animation

1 file changed

+3
-8
lines changed

adafruit_led_animation/animation/comet.py

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -55,14 +55,9 @@ class Comet(Animation):
5555
:param pixel_object: The initialised LED object.
5656
:param float speed: Animation speed in seconds, e.g. ``0.1``.
5757
:param color: Animation color in ``(r, g, b)`` tuple, or ``0x000000`` hex format.
58-
:param int tail_length: The length of the comet. Defaults to 10. Cannot exceed the number of
59-
pixels present in the pixel object, e.g. if the strip is 30 pixels
60-
long, the ``tail_length`` cannot exceed 30 pixels, or, in the case of a
61-
pixel mapped grid, if the width of the grid is 13 pixels, a horizontal
62-
comet tail cannot exceed 13 pixels. To find the lenth of the
63-
``pixel_object``, include a ``print(len(PIXEL_OBJECT_NAME))`` in your
64-
code anywhere after the object creation, where ``PIXEL_OBJECT_NAME`` is
65-
the name assigned to the object, such as ``pixels``.
58+
:param int tail_length: The length of the comet. Defaults to 25% of the length of the
59+
``pixel_object``. Automatically compensates for a minimum of 2 and a
60+
maximum of the length of the ``pixel_object``.
6661
:param bool reverse: Animates the comet in the reverse order. Defaults to ``False``.
6762
:param bool bounce: Comet will bounce back and forth. Defaults to ``True``.
6863
"""

0 commit comments

Comments
 (0)