!squash more

Author: tony

src/libtmux/test/waiter.py

@@ -492,8 +492,6 @@ def expect(pane: Pane) -> PaneContentWaiter:
     True
     >>>
 
-    Real-world usage examples (showing API only, not executed):
-
     Wait for text with a longer timeout:
 
     >>> pane.send_keys("echo 'Operation completed", enter=True)
@@ -613,40 +611,47 @@ def wait_for_pane_content(
     >>> isinstance(result_pred, WaitResult)
     True
 
-    Real-world usage examples (showing API only, not executed):
-
-    Wait for a $ shell prompt:
+    Wait for a `$` written on the screen (unsubmitted):
 
-    >>> # result = wait_for_pane_content(pane, "$", ContentMatchType.CONTAINS)
+    >>> pane.send_keys("$")
+    >>> result = wait_for_pane_content(pane, "$", ContentMatchType.CONTAINS)
 
-    Wait for exact text:
+    Wait for exact text (unsubmitted, and fails):
 
-    >>> # result = wait_for_pane_content(
-    >>> #     pane,
-    >>> #     "Success",
-    >>> #     ContentMatchType.EXACT,
-    >>> #     timeout=10.0
-    >>> # )
+    >>> try:
+    ...     pane.send_keys("echo 'Success'")
+    ...     result = wait_for_pane_content(
+    ...         pane,
+    ...         "Success",
+    ...         ContentMatchType.EXACT,
+    ...         timeout=0.01
+    ...     )
+    ... except WaitTimeout:
+    ...     print("No exact match.")
+    No exact match.
 
     Use regex pattern matching:
 
     >>> import re
-    >>> # result = wait_for_pane_content(
-    >>> #     pane,
-    >>> #     re.compile(r"Error: .*"),
-    >>> #     ContentMatchType.REGEX
-    >>> # )
+    >>> pane.send_keys("echo 'Error: There was a problem.'")
+    >>> result = wait_for_pane_content(
+    ...     pane,
+    ...     re.compile(r"Error: .*"),
+    ...     ContentMatchType.REGEX
+    ... )
 
     Use custom predicate function:
 
     >>> def has_at_least_3_lines(content):
     ...     return len(content) >= 3
 
-    >>> # result = wait_for_pane_content(
-    >>> #     pane,
-    >>> #     has_at_least_3_lines,
-    >>> #     ContentMatchType.PREDICATE
-    >>> # )
+    >>> for _ in range(5):
+    ...     pane.send_keys("echo 'A line'", enter=True)
+    >>> result = wait_for_pane_content(
+    ...     pane,
+    ...     has_at_least_3_lines,
+    ...     ContentMatchType.PREDICATE
+    ... )
     """
     result = WaitResult(success=False)