dotnet-api-docs icon indicating copy to clipboard operation
dotnet-api-docs copied to clipboard

Added detailed documentation for Stream.Read(Span<byte>) method.

Open jisaiaha opened this issue 1 year ago • 4 comments

This pull request enhances the documentation for the Stream.Read(Span<byte>) method. The following improvements have been made:

  • Exception Handling: Added detailed exception documentation for IOException, NotSupportedException, and ObjectDisposedException to ensure that developers are aware of the possible errors this method might throw.
  • Expanded Remarks: Clarified the method's behavior, including how the buffer is handled, when the position within the stream is advanced, and how exceptions affect the stream's position.
  • Streamlined Structure: Removed duplicated MemberSignature and ReturnValue blocks to improve readability and maintain a clean, concise structure.
  • Preserved Compatibility Information: Retained all relevant framework compatibility information, including assembly and parameter details.

jisaiaha avatar Sep 30 '24 03:09 jisaiaha