Repository navigation
docs: clarify default stderr capture behavior - #1200
Merged
zackees merged 1 commit intoSep 29, 2026
Merged
Conversation
Update the pipe-backed example and notes to document the current stderr capture contract: stderr is merged into stdout by default, while stderr=PIPE enables separate capture.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Updates the README to match the current stderr capture behaviour.
RunningProcess(...)mergesstderrintostdoutby default, while passingstderr=PIPEenables separate stdout/stderr capture.The pipe-backed example now demonstrates the split-capture form explicitly, and the Notes section has been corrected accordingly.
Background
The README currently states that stdout and stderr are no longer merged by default, but the implementation and regression tests use merged capture as the default.
The documented behaviour had drifted from the runtime contract, so this PR updates the documentation rather than changing runtime behaviour.
Scope
Documentation only. No runtime or API behaviour is changed.
This PR documents the current default stderr capture behaviour described in #1195.
Resolves #1195