Added note on state setter

beeware · Oct 27, 2024 · f44d48c · f44d48c
1 parent 7609fc1
commit f44d48c
Showing 1 changed file with 6 additions and 2 deletions.
diff --git a/core/src/toga/window.py b/core/src/toga/window.py
@@ -465,8 +465,12 @@ def visible(self, visible: bool) -> None:
 
     @property
     def state(self) -> WindowState:
-        """The current state of the window."""
-        # There are 2 types of window states that we can get:
+        """The current state of the window.
+
+        When the window is in transition, then this will return the state it
+        is transitioning towards, instead of the actual instantaneous state.
+        """
+        # There are 2 types of window states that we can get from the backend:
         # * The instantaneous state -- Used internally on implementation side
         # * The in-progress state -- Used for same state checking on the core
         #                            and for the public API.