!squash waiter

Author: tony

src/libtmux/test/waiter.py

@@ -460,25 +460,29 @@ def expect(pane: Pane) -> PaneContentWaiter:
 
     Examples
     --------
-    >>> # Basic usage with pane fixture
+    Basic usage with pane fixture:
+
     >>> waiter = expect(pane)
     >>> isinstance(waiter, PaneContentWaiter)
     True
 
-    >>> # Method chaining to configure the waiter
+    Method chaining to configure the waiter:
+
     >>> configured_waiter = expect(pane).with_timeout(15.0).without_raising()
     >>> configured_waiter.timeout
     15.0
     >>> configured_waiter.raises
     False
 
-    >>> # Equivalent to PaneContentWaiter but with a more expressive name
+    Equivalent to :class:`PaneContentWaiter` but with a more expressive name:
+
     >>> expect(pane) is not PaneContentWaiter(pane)  # Different instances
     True
     >>> type(expect(pane)) == type(PaneContentWaiter(pane))  # Same class
     True
 
-    >>> # A functional example showing actual usage
+    A functional example showing actual usage:
+
     >>> # Send a command to the pane
     >>> pane.send_keys("echo 'testing expect'", enter=True)
     >>>
@@ -487,20 +491,26 @@ def expect(pane: Pane) -> PaneContentWaiter:
     >>> result.success
     True
     >>>
-    >>> # Real-world usage examples (showing API only, not executed)
-    >>> # Wait for text with a longer timeout
-    >>> # result = (
-    >>> #     expect(pane)
-    >>> #     .with_timeout(10.0)
-    >>> #     .wait_for_text("Operation completed")
-    >>> # )
+
+    Real-world usage examples (showing API only, not executed):
+
+    Wait for text with a longer timeout:
+
+    >>> pane.send_keys("echo 'Operation completed", enter=True)
+    >>> result = (
+    ...     expect(pane)
+    ...     .with_timeout(10.0)
+    ...     .wait_for_text("Operation completed")
+    ... )
     >>>
-    >>> # Wait for a regex match without raising exceptions on timeout
-    >>> # result = (
-    >>> #     expect(pane)
-    >>> #     .without_raising()
-    >>> #     .wait_for_regex(r"Process \d+ completed")
-    >>> # )
+
+    Wait for a regex match without raising exceptions on timeout:
+    >>> pane.send_keys("echo 'Process 19 completed'", enter=True)
+    >>> result = (
+    ...     expect(pane)
+    ...     .without_raising()
+    ...     .wait_for_regex(r"Process \d+ completed")
+    ... )
     """
     return PaneContentWaiter(pane)
 
@@ -1002,34 +1012,41 @@ def wait_for_any_content(
 
     Examples
     --------
-    >>> # Example patterns for wait_for_any_content (showing API only, not executed)
-    >>> # Wait for any of the specified patterns
-    >>> # result = wait_for_any_content(
-    >>> #     pane,
-    >>> #     ["pattern1", "pattern2"],
-    >>> #     ContentMatchType.CONTAINS
-    >>> # )
-    >>>
-    >>> # Wait for any of the specified regex patterns
+    Wait for any of the specified patterns:
+
+    >>> pane.send_keys("echo 'pattern2'", enter=True)
+    >>> result = wait_for_any_content(
+    ...     pane,
+    ...     ["pattern1", "pattern2"],
+    ...     ContentMatchType.CONTAINS
+    ... )
+
+    Wait for any of the specified regex patterns:
+
     >>> import re
-    >>> # result = wait_for_any_content(
-    >>> #     pane,
-    >>> #     [re.compile(r"Error: .*"), re.compile(r"Success: .*")],
-    >>> #     ContentMatchType.REGEX
-    >>> # )
-    >>>
-    >>> # Wait for any of the specified predicate functions
+    >>> pane.send_keys("echo 'Error: this did not do the trick'", enter=True)
+    >>> pane.send_keys("echo 'Success: But subsequently this worked'", enter=True)
+    >>> result = wait_for_any_content(
+    ...     pane,
+    ...     [re.compile(r"Error: .*"), re.compile(r"Success: .*")],
+    ...     ContentMatchType.REGEX
+    ... )
+
+    Wait for any of the specified predicate functions:
+
     >>> def has_at_least_3_lines(content):
     ...     return len(content) >= 3
     >>>
     >>> def has_at_least_5_lines(content):
     ...     return len(content) >= 5
     >>>
-    >>> # result = wait_for_any_content(
-    >>> #     pane,
-    >>> #     [has_at_least_3_lines, has_at_least_5_lines],
-    >>> #     ContentMatchType.PREDICATE
-    >>> # )
+    >>> for _ in range(5):
+    ...     pane.send_keys("echo 'A line'", enter=True)
+    >>> result = wait_for_any_content(
+    ...     pane,
+    ...     [has_at_least_3_lines, has_at_least_5_lines],
+    ...     ContentMatchType.PREDICATE
+    ... )
     """
     if not content_patterns:
         msg = "At least one content pattern must be provided"