diff --git a/examples/advanced/sandbox/sandbox/particles.py b/examples/advanced/sandbox/sandbox/particles.py index f7a2f6ae..af84d540 100644 --- a/examples/advanced/sandbox/sandbox/particles.py +++ b/examples/advanced/sandbox/sandbox/particles.py @@ -176,7 +176,7 @@ class MovingElement(Element): """Base for moving elements.""" def _move(self, dy, dx): - """Try to move vertically by dy and horizontally by dx. True if successful.""" + """Try to move particle by dy, dx and return true if successful.""" world = self.world h, w = world.shape y, x = self.pos diff --git a/src/batgrl/gadgets/behaviors/grabbable.py b/src/batgrl/gadgets/behaviors/grabbable.py index 1466c84f..69b53167 100644 --- a/src/batgrl/gadgets/behaviors/grabbable.py +++ b/src/batgrl/gadgets/behaviors/grabbable.py @@ -34,7 +34,7 @@ class Grabbable: mouse_button : MouseButton Mouse button used for grabbing. is_grabbed : bool - True if gadget is grabbed. + Whether gadget is grabbed. Methods ------- @@ -84,7 +84,7 @@ def on_mouse(self, mouse_event): @property def is_grabbed(self) -> bool: - """True if gadget is grabbed.""" + """Whether gadget is grabbed.""" return self._is_grabbed def grab(self, mouse_event: MouseEvent): diff --git a/src/batgrl/gadgets/behaviors/movable.py b/src/batgrl/gadgets/behaviors/movable.py index 59b1034a..22cf0866 100644 --- a/src/batgrl/gadgets/behaviors/movable.py +++ b/src/batgrl/gadgets/behaviors/movable.py @@ -43,7 +43,7 @@ class Movable(Grabbable): mouse_button : MouseButton Mouse button used for grabbing. is_grabbed : bool - True if gadget is grabbed. + Whether gadget is grabbed. Methods ------- diff --git a/src/batgrl/gadgets/behaviors/movable_children.py b/src/batgrl/gadgets/behaviors/movable_children.py index 28ce9d47..93c42d21 100644 --- a/src/batgrl/gadgets/behaviors/movable_children.py +++ b/src/batgrl/gadgets/behaviors/movable_children.py @@ -43,7 +43,7 @@ class MovableChildren(Grabbable): mouse_button : MouseButton Mouse button used for grabbing. is_grabbed : bool - True if gadget is grabbed. + Whether gadget is grabbed. Methods ------- diff --git a/src/batgrl/gadgets/scroll_view.py b/src/batgrl/gadgets/scroll_view.py index 6124dc3f..c6eaddea 100644 --- a/src/batgrl/gadgets/scroll_view.py +++ b/src/batgrl/gadgets/scroll_view.py @@ -267,7 +267,7 @@ class ScrollView(Themable, Grabbable, Gadget): mouse_button : MouseButton Mouse button used for grabbing. is_grabbed : bool - True if gadget is grabbed. + Whether gadget is grabbed. alpha : float Transparency of gadget. size : Size diff --git a/src/batgrl/gadgets/slider.py b/src/batgrl/gadgets/slider.py index 33947123..1351d5f8 100644 --- a/src/batgrl/gadgets/slider.py +++ b/src/batgrl/gadgets/slider.py @@ -85,7 +85,7 @@ class Slider(Grabbable, Pane): fill_color: Color Color of filled portion of slider. slider_enabled : bool - True if slider value can be changed. + Whether slider value can be changed. proportion : float Current proportion of slider. is_grabbable : bool @@ -99,7 +99,7 @@ class Slider(Grabbable, Pane): alpha : float Transparency of gadget. is_grabbed : bool - True if gadget is grabbed. + Whether gadget is grabbed. size : Size Size of gadget. height : int diff --git a/src/batgrl/gadgets/split_layout.py b/src/batgrl/gadgets/split_layout.py index b9f9a04b..e72e3143 100644 --- a/src/batgrl/gadgets/split_layout.py +++ b/src/batgrl/gadgets/split_layout.py @@ -92,7 +92,7 @@ class HSplitLayout(Gadget): handle_color : AColor Color of the resize handle. split_resizable : bool - True if split is resizable with a grabbable handle. + Whether split is resizable with a grabbable handle. anchor_top_pane : bool If true, :attr:`split_row` is calculated from the top. split_row : int @@ -283,7 +283,7 @@ def split_row(self, split_row: int): @property def split_resizable(self) -> bool: - """True if split is resizable with a grabbable handle.""" + """Whether split is resizable with a grabbable handle.""" return self.handle.is_grabbable @split_resizable.setter @@ -349,7 +349,7 @@ class VSplitLayout(Gadget): handle_color : AColor Color of the resize handle. split_resizable : bool - True if split is resizable with a grabbable handle. + Whether split is resizable with a grabbable handle. anchor_left_pane : bool If true, :attr:`split_col` is calculated from the left. split_col : int @@ -541,7 +541,7 @@ def split_col(self, split_col: int): @property def split_resizable(self) -> bool: - """True if split is resizable with a grabbable handle.""" + """Whether split is resizable with a grabbable handle.""" return self.handle.is_grabbable @split_resizable.setter diff --git a/src/batgrl/gadgets/textbox.py b/src/batgrl/gadgets/textbox.py index dff6188c..98a5378b 100644 --- a/src/batgrl/gadgets/textbox.py +++ b/src/batgrl/gadgets/textbox.py @@ -114,7 +114,7 @@ class Textbox(Themable, Focusable, Grabbable, Gadget): mouse_button : MouseButton Mouse button used for grabbing. is_grabbed : bool - True if gadget is grabbed. + Whether gadget is grabbed. size : Size Size of gadget. height : int diff --git a/src/batgrl/gadgets/tree_view.py b/src/batgrl/gadgets/tree_view.py index ee7b1172..a59ff921 100644 --- a/src/batgrl/gadgets/tree_view.py +++ b/src/batgrl/gadgets/tree_view.py @@ -30,7 +30,7 @@ class TreeViewNode(Themable, ButtonBehavior, Text): Parameters ---------- is_leaf : bool, default: True - True if node is a leaf node. + Whether node is a leaf node. always_release : bool, default: False Whether a mouse up event outside the button will trigger it. default_cell : NDArray[Cell] | str, default: " "