diff --git a/TODO.md b/TODO.md index a379a7c2..e0c5e5ae 100644 --- a/TODO.md +++ b/TODO.md @@ -32,6 +32,7 @@ ## Refactoring +- Coroutine future OR document uuid - Account settings with `HTabbedContainer` - Get rid of all `currentSpacing` stuff - Use new default/reset controls system diff --git a/src/backend/pyotherside_events.py b/src/backend/pyotherside_events.py index b205b4a0..015db7ed 100644 --- a/src/backend/pyotherside_events.py +++ b/src/backend/pyotherside_events.py @@ -9,10 +9,11 @@ from .utils import serialize_value_for_qml @dataclass class PyOtherSideEvent: - """Event that will be sent to QML by PyOtherSide.""" + """Event that will be sent on instanciation to QML by PyOtherSide.""" def __post_init__(self) -> None: - # CPython >= 3.6 or any Python >= 3.7 needed for correct dict order + # CPython 3.6 or any Python implemention >= 3.7 is required for correct + # __dataclass_fields__ dict order. args = [ serialize_value_for_qml(getattr(self, field)) for field in self.__dataclass_fields__ # type: ignore @@ -29,9 +30,10 @@ class ExitRequested(PyOtherSideEvent): @dataclass class AlertRequested(PyOtherSideEvent): - """Request an alert to be shown for msec milliseconds. - The Alert state for example sets the urgency hint on X11/Wayland, - or flashes the taskbar icon on Windows. + """Request a window manager alert to be shown. + + Sets the urgency hint for compliant X11/Wayland window managers; + flashes the taskbar icon on Windows. """