dotnet / dotnet/dotnet-api-docs
Stream.Read(Span<byte>) and Stream.Write(ReadOnlySpan<byte>) are missing exception documentation
Open
:books: documentation
area-System.IO
doc-bug
documentation
Pri3
- Dominant language
- C#
- Stars
- 949
- Forks
- 1.7k
- Avg merge
- 3d 27m
- Merged PRs (30d)
- 49
Description
There are no exceptions documented for `Stream.Read(Span)` or `Stream.Write(ReadOnlySpan)`. These methods can throw `IOException`, `NotSupportedException`, and `ObjectDisposedException`.
https://github.com/dotnet/dotnet-api-docs/blob/1fc705651a652eda664835c7c2a4985461d308b0/xml/System.IO/Stream.xml#L1953-L2009
https://github.com/dotnet/dotnet-api-docs/blob/1fc705651a652eda664835c7c2a4985461d308b0/xml/System.IO/Stream.xml#L3115-L3168
Likewise, `BinaryWriter.Write(ReadOnlySpan)`.
https://github.com/dotnet/dotnet-api-docs/blob/1fc705651a652eda664835c7c2a4985461d308b0/xml/System.IO/BinaryWriter.xml#L1836-L1883
Contributor guide
Assessment
This issue has not been assessed yet.