Skip to content

Commit

Permalink
Update doc strings.
Browse files Browse the repository at this point in the history
  • Loading branch information
salt-die committed Feb 18, 2024
1 parent 5c0d91a commit 23599a7
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 6 deletions.
2 changes: 1 addition & 1 deletion batgrl/gadgets/animation.py
Original file line number Diff line number Diff line change
Expand Up @@ -274,7 +274,7 @@ def on_size(self):

@property
def is_transparent(self) -> bool:
"""If false, `alpha` and alpha channels are ignored."""
"""Whether gadget is transparent."""
return self._is_transparent

@is_transparent.setter
Expand Down
7 changes: 3 additions & 4 deletions batgrl/gadgets/graphic_field.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,9 @@ class GraphicParticleField(Gadget):
r"""
A graphic particle field.
A particle field specializes in rendering many single "pixel" children by
setting particle positions, colors, and alphas. (Note that alpha channel
of particle colors and particle alphas are independent and both control
particle transparency.) This is more efficient than rendering many 1x1 gadgets.
A particle field specializes in rendering many single "pixel" children with just
particle positions and colors. This is more efficient than rendering many 1x1
gadgets.
Parameters
----------
Expand Down
2 changes: 1 addition & 1 deletion batgrl/gadgets/parallax.py
Original file line number Diff line number Diff line change
Expand Up @@ -260,7 +260,7 @@ def on_size(self):

@property
def is_transparent(self) -> bool:
"""If false, `alpha` and alpha channels are ignored."""
"""Whether gadget is transparent."""
return self._is_transparent

@is_transparent.setter
Expand Down

0 comments on commit 23599a7

Please sign in to comment.