!squash docs waiter.md use autodoc

Author: tony

docs/test-helpers/waiter.md

@@ -1,3 +1,5 @@
+(waiter)=
+
 # Terminal Content Waiters
 
 The waiter module provides utilities for waiting on specific content to appear in tmux panes, making it easier to write reliable tests that interact with terminal output.
@@ -92,90 +94,20 @@ The waiter module also supports waiting for multiple conditions at once:
 
 ## API Reference
 
-### Low-level Functions
-
-* `wait_for_text(pane, text, timeout=10, interval=0.05, raises=True)`
-* `wait_for_exact_text(pane, text, timeout=10, interval=0.05, raises=True)`
-* `wait_for_regex(pane, pattern, timeout=10, interval=0.05, raises=True)`
-* `wait_for_predicate(pane, predicate, timeout=10, interval=0.05, raises=True)`
-* `wait_for_pane_content(pane, content_pattern, match_type, timeout=10, interval=0.05, raises=True)`
-* `wait_for_any_content(pane, patterns, match_type=ContentMatchType.CONTAINS, timeout=10, interval=0.05, raises=True)`
-* `wait_for_all_content(pane, patterns, match_type=ContentMatchType.CONTAINS, timeout=10, interval=0.05, raises=True)`
-* `wait_until_pane_ready(pane, shell_prompt=None, match_type=ContentMatchType.CONTAINS, timeout=10, interval=0.05, raises=True)`
-
-### Fluent API
-
-The fluent API provides a more expressive way to wait for content in panes:
-
-```python
-# Create a waiter
-waiter = expect(pane)
-
-# Configure the waiter
-waiter = waiter.to_contain_text("text")
-waiter = waiter.to_match_regex(pattern)
-waiter = waiter.with_timeout(5)
-waiter = waiter.with_interval(0.1)
-
-# Wait for the condition and get the result
-result = waiter.wait()
+```{eval-rst}
+.. automodule:: libtmux.test.waiter
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :member-order: bysource
 ```
 
-#### Terminal Methods
-These methods perform the actual wait operation and return a `WaitResult`:
-
-* `wait()`
-
-#### Configurator Methods
-These methods configure the waiter and return a new waiter with the updated configuration:
-
-* `to_contain_text(text)`
-* `to_contain_exact_text(text)`
-* `to_match_regex(pattern)`
-* `to_satisfy_predicate(predicate)`
-* `to_contain_any_text(texts)`
-* `to_contain_all_texts(texts)`
-* `with_timeout(timeout)`
-* `with_interval(interval)`
-* `without_raises()`
-
-#### Parameters
+## Extended Retry Functionality
 
-- `pane`: A tmux pane object to wait on
-- `content_pattern`: The pattern to match (string, regex, or function)
-- `match_type`: How to match the pattern (ContentMatchType.CONTAINS, EXACT, REGEX, or PREDICATE)
-- `timeout`: Maximum time to wait in seconds
-- `interval`: Time between checks in seconds
-- `raises`: Whether to raise an exception on timeout
-
-**Returns:**
-* `WaitResult`: An object containing the result of the wait operation, including:
-  * `success`: Whether the wait was successful
-  * `content`: The content of the pane at the time of success or timeout
-  * `matched_content`: The matched content, if successful
-  * `match_line`: The line number of the matched content, if successful
-  * `elapsed_time`: The time elapsed during the wait
-  * `error`: The error message, if any
-  * `matched_pattern_index`: The index of the matched pattern (for wait_for_any_content)
-
-## Implementation Notes
-
-### Error Handling
-
-The waiting functions are designed to be robust and handle timing and error conditions gracefully:
-
-- All wait functions properly calculate elapsed time for performance tracking
-- Functions handle exceptions consistently and provide clear error messages
-- Proper handling of return values ensures consistent behavior whether or not raises=True
-
-### Type Safety
-
-The waiter module is fully type-annotated to ensure compatibility with static type checkers:
-
-- All functions include proper type hints for parameters and return values
-- The ContentMatchType enum ensures that only valid match types are used
-- Combined with runtime checks, this prevents type-related errors during testing
-
-### Example Usage in Documentation
-
-All examples in this documentation are actual test files from the libtmux test suite. The examples are included using `literalinclude` directives, ensuring that the documentation remains synchronized with the actual code.
+```{eval-rst}
+.. automodule:: libtmux.test.retry_extended
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :member-order: bysource
+```