dotnet / dotnet/dotnet-api-docs
BinaryWriter: Out of context paragraph
- Dominant language
- C#
- Stars
- 949
- Forks
- 1.7k
- Avg merge
- 3d 27m
- Merged PRs (30d)
- 49
Description
The second paragraph under Remarks at https://docs.microsoft.com/en-us/dotnet/api/system.io.binarywriter.close?view=netcore-3.1 seems apropos of nothing.
https://github.com/dotnet/dotnet-api-docs/blob/master/xml/System.IO/BinaryWriter.xml#L458
Is it saying that close calls Flush but I also need to explicitly Flush an Encoder somewhere?
The same text appears under Flush (https://docs.microsoft.com/en-us/dotnet/api/system.io.binarywriter.flush?view=netcore-3.1)
https://github.com/dotnet/dotnet-api-docs/blob/master/xml/System.IO/BinaryWriter.xml#L669
It's even more confusing there - when it says flushing the stream it is presumably talking about the underlying stream - but explicitly calling Flush on the stream or the writer?
Contributor guide
Assessment
This issue has not been assessed yet.