Skip to content

Commit

Permalink
fix doc of bounce
Browse files Browse the repository at this point in the history
Fix documentation of the default `bounce` value for `Comet` and
`RainbowComet`.

Signed-off-by: Taylor Yu <code@argon.blue>
  • Loading branch information
tlyu committed Jan 22, 2023
1 parent 56728e3 commit a2c36c6
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion adafruit_led_animation/animation/comet.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ class Comet(Animation):
``pixel_object``. Automatically compensates for a minimum of 2 and a
maximum of the length of the ``pixel_object``.
: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``.
"""

Expand Down
2 changes: 1 addition & 1 deletion adafruit_led_animation/animation/rainbowcomet.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ class RainbowComet(Comet):
pixels present in the pixel object, e.g. if the strip is 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 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 step: Colorwheel step (defaults to automatic).
:param bool ring: Ring mode. Defaults to ``False``.
Expand Down

0 comments on commit a2c36c6

Please sign in to comment.