!squash waiter

Author: tony

src/libtmux/test/waiter.py

@@ -200,8 +200,8 @@ class PaneContentWaiter:
     >>> hasattr(waiter, 'wait_until_ready')
     True
 
-    >>> # Real-world usage examples
-    >>> # A functional example: send text to the pane and wait for it
+    A functional example: send text to the pane and wait for it:
+
     >>> # First, send "hello world" to the pane
     >>> pane.send_keys("echo 'hello world'", enter=True)
     >>>
@@ -212,27 +212,42 @@ class PaneContentWaiter:
     >>> "hello world" in result.matched_content
     True
     >>>
-    >>> # Basic usage (showing API only, other examples)
-    >>> # result = PaneContentWaiter(pane).wait_for_text("other example")
-    >>>
-    >>> # With options
-    >>> # result = (
-    >>> #     PaneContentWaiter(pane)
-    >>> #     .with_timeout(10.0)
-    >>> #     .wait_for_exact_text("completed successfully")
-    >>> # )
-    >>>
-    >>> # Wait for regex pattern
-    >>> # result = (
-    >>> #     PaneContentWaiter(pane)
-    >>> #     .with_timeout(10.0)
-    >>> #     .wait_for_regex(r"Process \d+ completed")
-    >>> # )
-    >>>
-    >>> # Custom predicate
+
+    With options:
+
+    >>> result = (
+    ...     PaneContentWaiter(pane)
+    ...     .with_timeout(5.0)
+    ...     .wait_for_text("hello world")
+    ... )
+
+    Wait for regex pattern:
+
+    >>> pane.send_keys("echo 'Process 0 completed.", enter=True)
+    >>> result = (
+    ...     PaneContentWaiter(pane)
+    ...     .with_timeout(10.0)
+    ...     .wait_for_regex(r"Process \d+ completed")
+    ... )
+
+    Custom predicate:
+
+    >>> pane.send_keys("echo 'We are ready!'", enter=True)
     >>> def is_ready(content):
     ...     return any("ready" in line.lower() for line in content)
-    >>> # result = PaneContentWaiter(pane).wait_for_predicate(is_ready)
+    >>> result = PaneContentWaiter(pane).wait_for_predicate(is_ready)
+
+    Timeout:
+
+    >>> try:
+    ...     result = (
+    ...         PaneContentWaiter(pane)
+    ...         .with_timeout(0.01)
+    ...         .wait_for_exact_text("hello world")
+    ...     )
+    ... except WaitTimeout:
+    ...     print('No exact match')
+    No exact match
     """
 
     def __init__(self, pane: Pane) -> None: