diff --git a/src/Ramstack.FileSystem.Abstractions/Utilities/PathTokenizer.cs b/src/Ramstack.FileSystem.Abstractions/Utilities/PathTokenizer.cs index f34a401..879a53d 100644 --- a/src/Ramstack.FileSystem.Abstractions/Utilities/PathTokenizer.cs +++ b/src/Ramstack.FileSystem.Abstractions/Utilities/PathTokenizer.cs @@ -17,7 +17,7 @@ public Enumerator GetEnumerator() => new Enumerator(path); /// - /// Tokenizes the specified path into a collection of the path components. + /// Tokenizes the specified path into a collection of path components. /// /// The file path to tokenize. /// diff --git a/src/Ramstack.FileSystem.Abstractions/VirtualFileSystemExtensions.cs b/src/Ramstack.FileSystem.Abstractions/VirtualFileSystemExtensions.cs index 9c8e966..6239b78 100644 --- a/src/Ramstack.FileSystem.Abstractions/VirtualFileSystemExtensions.cs +++ b/src/Ramstack.FileSystem.Abstractions/VirtualFileSystemExtensions.cs @@ -97,7 +97,7 @@ public static ValueTask WriteAsync(this IVirtualFileSystem fs, string path, Stre fs.GetFile(path).WriteAsync(stream, overwrite, cancellationToken); /// - /// Asynchronously reads all the text in the file with the specified encoding. + /// Asynchronously reads all the text in the file. /// /// The file system to use. /// The file from which to read the entire text content. @@ -124,7 +124,7 @@ public static ValueTask ReadAllTextAsync(this IVirtualFileSystem fs, str fs.GetFile(path).ReadAllTextAsync(encoding, cancellationToken); /// - /// Asynchronously reads all lines of the file with the specified encoding. + /// Asynchronously reads all lines of the file. /// /// The file system to use. /// The file to read from. diff --git a/src/Ramstack.FileSystem.Abstractions/VirtualPath.cs b/src/Ramstack.FileSystem.Abstractions/VirtualPath.cs index 236a08e..dd75453 100644 --- a/src/Ramstack.FileSystem.Abstractions/VirtualPath.cs +++ b/src/Ramstack.FileSystem.Abstractions/VirtualPath.cs @@ -157,11 +157,11 @@ public static ReadOnlySpan GetDirectoryName(ReadOnlySpan path) } /// - /// Determines if the specified path in a normalized form. + /// Determines if the specified path is in a normalized form. /// /// The path to test. /// - /// if the path in a normalized form; + /// if the path is in a normalized form; /// otherwise, . /// public static bool IsNormalized(ReadOnlySpan path) diff --git a/src/Ramstack.FileSystem.Amazon/AccessControl.cs b/src/Ramstack.FileSystem.Amazon/AccessControl.cs index aa830a9..aaab177 100644 --- a/src/Ramstack.FileSystem.Amazon/AccessControl.cs +++ b/src/Ramstack.FileSystem.Amazon/AccessControl.cs @@ -44,7 +44,7 @@ public enum AccessControl AwsExecRead, /// - /// Object Owner gets FULL_CONTROL, Bucket Owner gets READ + /// Object Owner gets FULL_CONTROL, Bucket Owner gets READ. /// This ACL applies only to objects and is equivalent to private when used with PUT Bucket. /// You use this ACL to let someone other than the bucket owner write content (get full control) /// in the bucket but still grant the bucket owner read access to the objects. diff --git a/src/Ramstack.FileSystem.Amazon/S3Directory.cs b/src/Ramstack.FileSystem.Amazon/S3Directory.cs index 43fd1f4..e339e9e 100644 --- a/src/Ramstack.FileSystem.Amazon/S3Directory.cs +++ b/src/Ramstack.FileSystem.Amazon/S3Directory.cs @@ -54,7 +54,7 @@ protected override async ValueTask DeleteCoreAsync(CancellationToken cancellatio { // The maximum number of objects returned is MaxKeys, which is 1000, // and the maximum number of objects that can be deleted at once is also 1000. - // Therefore, we can rely (sure?) on this and avoid splitting + // Therefore, we can rely on this and avoid splitting // the retrieved objects into separate batches. var response = await _fs.AmazonClient diff --git a/src/Ramstack.FileSystem.Composite/CompositeDirectory.cs b/src/Ramstack.FileSystem.Composite/CompositeDirectory.cs index 4622791..704d918 100644 --- a/src/Ramstack.FileSystem.Composite/CompositeDirectory.cs +++ b/src/Ramstack.FileSystem.Composite/CompositeDirectory.cs @@ -17,7 +17,7 @@ internal sealed class CompositeDirectory : VirtualDirectory /// /// Initializes a new instance of the class. /// - /// The file system associated with this file. + /// The file system associated with this directory. /// The path of the directory. public CompositeDirectory(CompositeFileSystem fileSystem, string path) : base(path) => _fs = fileSystem; diff --git a/src/Ramstack.FileSystem.Composite/CompositeFileSystem.Helpers.cs b/src/Ramstack.FileSystem.Composite/CompositeFileSystem.Helpers.cs index 2bc0a52..92ba03b 100644 --- a/src/Ramstack.FileSystem.Composite/CompositeFileSystem.Helpers.cs +++ b/src/Ramstack.FileSystem.Composite/CompositeFileSystem.Helpers.cs @@ -5,7 +5,7 @@ namespace Ramstack.FileSystem.Composite; partial class CompositeFileSystem { /// - /// Tries to flatten the specified into a flat list of the . + /// Tries to flatten the specified into a flat list of instances. /// /// /// If the is not a , @@ -13,7 +13,7 @@ partial class CompositeFileSystem /// /// The to flatten. /// - /// A that represents the flattened version of the specified . + /// An that represents the flattened version of the specified . /// public static IVirtualFileSystem Flatten(IVirtualFileSystem fileSystem) { @@ -26,14 +26,14 @@ public static IVirtualFileSystem Flatten(IVirtualFileSystem fileSystem) } /// - /// Creates an instance of the from the specified list and flattens it into a flat list of file systems. + /// Creates an from the specified list, flattening any nested instances. /// /// /// This method returns a if more than one file system remains after flattening. /// /// The list of instances to compose and flatten. /// - /// A that represents the flattened version of the specified list of the . + /// An that represents the flattened version of the specified list of instances. /// public static IVirtualFileSystem Create(params IVirtualFileSystem[] list) => list.Length != 1 @@ -41,14 +41,14 @@ public static IVirtualFileSystem Create(params IVirtualFileSystem[] list) => : Flatten(list[0]); /// - /// Creates an instance of the from the specified list and flattens it into a flat list of file systems. + /// Creates an from the specified list, flattening any nested instances. /// /// /// This method returns a if more than one file system remains after flattening. /// /// The list of instances to compose and flatten. /// - /// A that represents the flattened version of the specified list of the . + /// An that represents the flattened version of the specified list of instances. /// public static IVirtualFileSystem Create(IEnumerable list) { diff --git a/src/Ramstack.FileSystem.Globbing/Internal/PathHelper.cs b/src/Ramstack.FileSystem.Globbing/Internal/PathHelper.cs index 6498843..8afe664 100644 --- a/src/Ramstack.FileSystem.Globbing/Internal/PathHelper.cs +++ b/src/Ramstack.FileSystem.Globbing/Internal/PathHelper.cs @@ -18,7 +18,7 @@ internal static class PathHelper /// /// Determines whether the specified path matches any of the specified patterns. /// - /// The path to match for a match. + /// The path to test for a match. /// An array of patterns to match against the path. /// /// if the path matches any of the patterns; diff --git a/src/Ramstack.FileSystem.Physical/PhysicalDirectory.cs b/src/Ramstack.FileSystem.Physical/PhysicalDirectory.cs index acf9fd2..d9272fb 100644 --- a/src/Ramstack.FileSystem.Physical/PhysicalDirectory.cs +++ b/src/Ramstack.FileSystem.Physical/PhysicalDirectory.cs @@ -68,7 +68,7 @@ protected override ValueTask DeleteCoreAsync(CancellationToken cancellationToken } catch (DirectoryNotFoundException) { - // The path to the deleting directory may not exist. + // The path of the directory being deleted may not exist. // This is a safe scenario and does not require further handling. } diff --git a/src/Ramstack.FileSystem.Physical/PhysicalFile.cs b/src/Ramstack.FileSystem.Physical/PhysicalFile.cs index 776c92a..4870d0c 100644 --- a/src/Ramstack.FileSystem.Physical/PhysicalFile.cs +++ b/src/Ramstack.FileSystem.Physical/PhysicalFile.cs @@ -43,7 +43,7 @@ internal PhysicalFile(PhysicalFileSystem fileSystem, string path, string physica /// protected override ValueTask OpenReadCoreAsync(CancellationToken cancellationToken) { - // SequentialScan is a performance hint that requires extra sys-call on non-Windows systems. + // SequentialScan is a performance hint that requires an extra system call on non-Windows systems. // https://github.com/dotnet/runtime/blob/46c9a4fff83f35ec659e6659050440aadccf3201/src/libraries/System.Private.CoreLib/src/System/IO/File.cs#L694 var options = OperatingSystem.IsWindows() ? FileOptions.Asynchronous | FileOptions.SequentialScan @@ -119,7 +119,7 @@ protected override ValueTask DeleteCoreAsync(CancellationToken cancellationToken } catch (DirectoryNotFoundException) { - // The path to the deleting file may not exist. + // The path of the file being deleted may not exist. // This is a safe scenario and does not require further handling. } diff --git a/src/Ramstack.FileSystem.Readonly/ReadonlyDirectory.cs b/src/Ramstack.FileSystem.Readonly/ReadonlyDirectory.cs index 3fc4c9e..068c74d 100644 --- a/src/Ramstack.FileSystem.Readonly/ReadonlyDirectory.cs +++ b/src/Ramstack.FileSystem.Readonly/ReadonlyDirectory.cs @@ -16,7 +16,7 @@ internal sealed class ReadonlyDirectory : VirtualDirectory /// /// Initializes a new instance of the class. /// - /// The file system associated with this file. + /// The file system associated with this directory. /// The instance to wrap. public ReadonlyDirectory(ReadonlyFileSystem fileSystem, VirtualDirectory directory) : base(directory.FullName) => (_fs, _directory) = (fileSystem, directory); diff --git a/src/Ramstack.FileSystem.Sub/SubDirectory.cs b/src/Ramstack.FileSystem.Sub/SubDirectory.cs index 474edfc..0fdd339 100644 --- a/src/Ramstack.FileSystem.Sub/SubDirectory.cs +++ b/src/Ramstack.FileSystem.Sub/SubDirectory.cs @@ -17,7 +17,7 @@ internal sealed class SubDirectory : VirtualDirectory /// Initializes a new instance of the class. /// /// The file system associated with this directory. - /// The path of the file. + /// The path of the directory. /// The underlying instance to wrap. public SubDirectory(SubFileSystem fileSystem, string path, VirtualDirectory directory) : base(path) => (_fs, _directory) = (fileSystem, directory);