dotnet / dotnet-api-docs

.NET API reference documentation (.NET 5+, .NET Core, .NET Framework)
https://docs.microsoft.com/dotnet/api/
Other
719 stars 1.56k forks source link

Position advancement is not mentioned #10163

Open marabzadeh86 opened 2 months ago

marabzadeh86 commented 2 months ago

Type of issue

Missing information

Description

While the documentation for Write() mentions that a successful write advances the Position by the number of written bytes, the page that documents WriteByte() does not mention a similar behavior.

Page URL

https://learn.microsoft.com/en-us/dotnet/api/system.io.memorystream.writebyte?view=net-8.0

Content source URL

https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.IO/MemoryStream.xml

Document Version Independent Id

ee6a4a0c-c5cd-1b1b-8e31-6837435bf27b

Article author

@dotnet-bot

dotnet-policy-service[bot] commented 2 months ago

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

jozkee commented 2 months ago

May be worth looking other Streams where this is not mentioned, also on Write/Read/ReadByte. e.g: https://learn.microsoft.com/en-us/dotnet/api/system.io.bufferedstream.writebyte?view=net-8.0