docstrings

This commit is contained in:
Will McGugan
2023-02-21 10:12:04 +00:00
parent 6a665d088a
commit 53e2ea77c3
2 changed files with 6 additions and 0 deletions

View File

@@ -308,6 +308,9 @@ class Compositor:
parent: The root widget.
size: Size of the area to be filled.
Returns:
Set of widgets that were exposed by the scroll.
"""
self._cuts = None
self._layers = None

View File

@@ -18,8 +18,11 @@ ArrangeResult: TypeAlias = "tuple[list[WidgetPlacement], set[Widget]]"
@dataclass
class DockArrangeResult:
placements: list[WidgetPlacement]
"""A `WidgetPlacement` for every widget to describe it's location on screen."""
widgets: set[Widget]
"""A set of widgets in the arrangement."""
spacing: Spacing
"""Shared spacing around the widgets."""
_spatial_map: SpatialMap[WidgetPlacement] | None = None