Commit 1dd6d2a
committed
docs(run[deadline]) Note callback fires on stderr only
why: ``_wait_with_deadline`` now drains both ``stdout`` and ``stderr``
to prevent a chatty child from deadlocking on a full pipe, but the
progress callback only fires for ``stderr`` chunks (matching the legacy
non-timeout codepath). Without an explicit note, callers who pass
``log_in_real_time=True`` and expect ``stdout`` lines to surface in
their callback will be surprised when the buffer is silent.
what:
- Add a Notes paragraph to ``_wait_with_deadline``'s docstring stating
that the callback fires on ``stderr`` chunks only by design, and
pointing callers who want streaming ``stdout`` toward redirecting
the stream themselves instead of relying on the callback.1 parent 0967d3d commit 1dd6d2a
1 file changed
Lines changed: 9 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
342 | 342 | | |
343 | 343 | | |
344 | 344 | | |
| 345 | + | |
| 346 | + | |
| 347 | + | |
| 348 | + | |
| 349 | + | |
| 350 | + | |
| 351 | + | |
| 352 | + | |
| 353 | + | |
345 | 354 | | |
346 | 355 | | |
347 | 356 | | |
| |||
0 commit comments