Skip to content

Commit 8ad2e98

Browse files
authored
docs: improve documentation for FileSystemStream (#971)
Fixes #943: > The XML docs say Wraps the <see cref="FileStream" />, but the wrapped field, _stream, is of type Stream. There's no runtime check to ensure that the stream provided in the constructor is of type FileStream. This is confusing because the docs state one thing, but the implementation doesn't seem to match that.
1 parent 6ade494 commit 8ad2e98

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

src/TestableIO.System.IO.Abstractions/FileSystemStream.cs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44
namespace System.IO.Abstractions
55
{
66
/// <summary>
7-
/// Wraps the <see cref="FileStream" />.
7+
/// Wrapper around a <see cref="Stream"/> which is used as a replacement
8+
/// for a <see cref="FileStream"/>. As such it implements the same
9+
/// properties and methods as a <see cref="FileStream"/>.
810
/// </summary>
911
public abstract class FileSystemStream : Stream
1012
{

0 commit comments

Comments
 (0)