Clarify that DataReceivedEventArgs.Data is null at end of stream#12657
Open
Copilot wants to merge 3 commits into
Open
Clarify that DataReceivedEventArgs.Data is null at end of stream#12657Copilot wants to merge 3 commits into
Copilot wants to merge 3 commits into
Conversation
Agent-Logs-Url: https://github.com/dotnet/dotnet-api-docs/sessions/365f3afd-ac6d-4f5c-8b59-e3fbccdbb8a4 Co-authored-by: adamsitnik <6011991+adamsitnik@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Fix final newline detection in OutputDataReceived
Clarify that DataReceivedEventArgs.Data is null at end of stream
May 25, 2026
github-actions
Bot
added
the
needs-area-label
adamsitnik
removed
the
needs-area-label
Contributor
|
Tagging subscribers to this area: @dotnet/area-system-diagnostics-process |
Contributor
There was a problem hiding this comment.
Pull request overview
Clarifies that DataReceivedEventArgs.Data is null when the redirected stream reaches end-of-stream, and documents the same end-of-stream signaling behavior on Process.OutputDataReceived and Process.ErrorDataReceived event remarks.
Changes:
- Updates the
<value>ofDataReceivedEventArgs.Datato note the value isnullat end of stream. - Adds a paragraph to
Process.ErrorDataReceivedremarks describing the null-data end-of-stream event. - Adds the analogous paragraph to
Process.OutputDataReceivedremarks.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| xml/System.Diagnostics/DataReceivedEventArgs.xml | Extends the Data property's <value> text to state it is null at end of stream. |
| xml/System.Diagnostics/Process.xml | Adds end-of-stream/null-data clarification paragraphs to ErrorDataReceived and OutputDataReceived remarks. |
gewarren
reviewed
May 26, 2026
Contributor
gewarren
left a comment
gewarren
left a comment
There was a problem hiding this comment.
One minor wording suggestion.
Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
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
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.
Process.OutputDataReceived/ErrorDataReceivedraise a final event withData == nullwhen the redirected stream closes, but this wasn't clearly documented—making it impossible to distinguish "no trailing newline" from "end of stream" without reading the source.DataReceivedEventArgs.Data<value>to state the property isnullat end of streamOutputDataReceivedandErrorDataReceivedremarks noting the null-data end-of-stream signal