Merge pull request #109 from tlyu/comet-doc

fix doc of `bounce`
This commit is contained in:
Scott Shawcroft 2023-01-23 09:47:05 -08:00 committed by GitHub
commit 9215d0893f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 2 additions and 2 deletions

View file

@ -41,7 +41,7 @@ class Comet(Animation):
``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``.
: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 ``False``.
:param bool ring: Ring mode. Defaults to ``False``. :param bool ring: Ring mode. Defaults to ``False``.
""" """

View file

@ -40,7 +40,7 @@ class RainbowComet(Comet):
pixels present in the pixel object, e.g. if the strip is 30 pixels pixels present in the pixel object, e.g. if the strip is 30 pixels
long, the ``tail_length`` cannot exceed 30 pixels. long, the ``tail_length`` cannot exceed 30 pixels.
: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 ``False``.
:param int colorwheel_offset: Offset from start of colorwheel (0-255). :param int colorwheel_offset: Offset from start of colorwheel (0-255).
:param int step: Colorwheel step (defaults to automatic). :param int step: Colorwheel step (defaults to automatic).
:param bool ring: Ring mode. Defaults to ``False``. :param bool ring: Ring mode. Defaults to ``False``.