Skip to content

Conversation

ViveliDuCh
Copy link
Member

@ViveliDuCh ViveliDuCh commented Sep 19, 2025

Fixes dotnet/runtime#118748

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
Contributor

Tagging subscribers to this area: @dotnet/area-system-io

@ViveliDuCh ViveliDuCh merged commit 5e23c9a into main Sep 22, 2025
5 checks passed
@ViveliDuCh ViveliDuCh deleted the viveliduc-doc-patch branch September 22, 2025 20:06
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.

StreamWriter/StreamReader buffer size inconsistencies
2 participants