Skip to content

Conversation

ViveliDuCh
Copy link
Member

Correct bufferSize parameter descriptions in StreamReader and StreamWriter XML docs

  • Clarify StreamReader.bufferSize sets the internal byte buffer; StreamWriter.bufferSize sets the internal char buffer
  • Remove incorrect buffer size units and misleading references
  • Omit secondary buffer details for clarity
  • Align docs with implementation and recent runtime changes

Note that both classes allocate both buffer types, but bufferSize only directly affects one.
Documentation update in response to issue dotnet/runtime#118748 and code changes in PR dotnet/runtime#118958

Copy link
Member

@jozkee jozkee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

StreamWriter must be changed too, it describes bufferSize in terms of bytes but is actually in terms of chars.

@dotnet-policy-service dotnet-policy-service bot added needs-author-action An issue or pull request that requires more info or actions from the author. and removed needs-author-action An issue or pull request that requires more info or actions from the author. labels Sep 19, 2025
@ViveliDuCh ViveliDuCh requested a review from jozkee September 19, 2025 17:55
@ViveliDuCh ViveliDuCh requested a review from jozkee September 19, 2025 18:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants