Skip to content

Commit 2af7dad

Browse files
Document polling callback contract validation
Co-authored-by: Shri Sukhani <shrisukhani@users.noreply.github.com>
1 parent 919e039 commit 2af7dad

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,10 @@ These methods now support explicit polling controls:
137137
- `max_status_failures` (default `5`)
138138

139139
Timing values must be finite, non-negative numbers.
140+
Polling callback contracts are also validated:
141+
142+
- Sync polling helpers require non-awaitable callback return values.
143+
- Async polling helpers require awaitable status/page/retry callbacks.
140144

141145
Example:
142146

0 commit comments

Comments
 (0)