Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ public Enumerator GetEnumerator() =>
new Enumerator(path);

/// <summary>
/// Tokenizes the specified path into a collection of the path components.
/// Tokenizes the specified path into a collection of path components.
/// </summary>
/// <param name="path">The file path to tokenize.</param>
/// <returns>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ public static ValueTask WriteAsync(this IVirtualFileSystem fs, string path, Stre
fs.GetFile(path).WriteAsync(stream, overwrite, cancellationToken);

/// <summary>
/// Asynchronously reads all the text in the file with the specified encoding.
/// Asynchronously reads all the text in the file.
/// </summary>
/// <param name="fs">The file system to use.</param>
/// <param name="path">The file from which to read the entire text content.</param>
Expand All @@ -124,7 +124,7 @@ public static ValueTask<string> ReadAllTextAsync(this IVirtualFileSystem fs, str
fs.GetFile(path).ReadAllTextAsync(encoding, cancellationToken);

/// <summary>
/// Asynchronously reads all lines of the file with the specified encoding.
/// Asynchronously reads all lines of the file.
/// </summary>
/// <param name="fs">The file system to use.</param>
/// <param name="path">The file to read from.</param>
Expand Down
4 changes: 2 additions & 2 deletions src/Ramstack.FileSystem.Abstractions/VirtualPath.cs
Original file line number Diff line number Diff line change
Expand Up @@ -157,11 +157,11 @@ public static ReadOnlySpan<char> GetDirectoryName(ReadOnlySpan<char> path)
}

/// <summary>
/// Determines if the specified path in a normalized form.
/// Determines if the specified path is in a normalized form.
/// </summary>
/// <param name="path">The path to test.</param>
/// <returns>
/// <see langword="true" /> if the path in a normalized form;
/// <see langword="true" /> if the path is in a normalized form;
/// otherwise, <see langword="false" />.
/// </returns>
public static bool IsNormalized(ReadOnlySpan<char> path)
Expand Down
2 changes: 1 addition & 1 deletion src/Ramstack.FileSystem.Amazon/AccessControl.cs
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ public enum AccessControl
AwsExecRead,

/// <summary>
/// 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.
Expand Down
2 changes: 1 addition & 1 deletion src/Ramstack.FileSystem.Amazon/S3Directory.cs
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/Ramstack.FileSystem.Composite/CompositeDirectory.cs
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ internal sealed class CompositeDirectory : VirtualDirectory
/// <summary>
/// Initializes a new instance of the <see cref="CompositeDirectory"/> class.
/// </summary>
/// <param name="fileSystem">The file system associated with this file.</param>
/// <param name="fileSystem">The file system associated with this directory.</param>
/// <param name="path">The path of the directory.</param>
public CompositeDirectory(CompositeFileSystem fileSystem, string path) : base(path) =>
_fs = fileSystem;
Expand Down
12 changes: 6 additions & 6 deletions src/Ramstack.FileSystem.Composite/CompositeFileSystem.Helpers.cs
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ namespace Ramstack.FileSystem.Composite;
partial class CompositeFileSystem
{
/// <summary>
/// Tries to flatten the specified <see cref="IVirtualFileSystem"/> into a flat list of the <see cref="IVirtualFileSystem"/>.
/// Tries to flatten the specified <see cref="IVirtualFileSystem"/> into a flat list of <see cref="IVirtualFileSystem"/> instances.
/// </summary>
/// <remarks>
/// If the <paramref name="fileSystem"/> is not a <see cref="CompositeFileSystem"/>,
/// the same instance of the <paramref name="fileSystem"/> is returned.
/// </remarks>
/// <param name="fileSystem">The <see cref="IVirtualFileSystem"/> to flatten.</param>
/// <returns>
/// A <see cref="IVirtualFileSystem"/> that represents the flattened version of the specified <see cref="IVirtualFileSystem"/>.
/// An <see cref="IVirtualFileSystem"/> that represents the flattened version of the specified <see cref="IVirtualFileSystem"/>.
/// </returns>
public static IVirtualFileSystem Flatten(IVirtualFileSystem fileSystem)
{
Expand All @@ -26,29 +26,29 @@ public static IVirtualFileSystem Flatten(IVirtualFileSystem fileSystem)
}

/// <summary>
/// Creates an instance of the <see cref="IVirtualFileSystem"/> from the specified list and flattens it into a flat list of file systems.
/// Creates an <see cref="IVirtualFileSystem"/> from the specified list, flattening any nested <see cref="CompositeFileSystem"/> instances.
/// </summary>
/// <remarks>
/// This method returns a <see cref="CompositeFileSystem"/> if more than one file system remains after flattening.
/// </remarks>
/// <param name="list">The list of <see cref="IVirtualFileSystem"/> instances to compose and flatten.</param>
/// <returns>
/// A <see cref="IVirtualFileSystem"/> that represents the flattened version of the specified list of the <see cref="IVirtualFileSystem"/>.
/// An <see cref="IVirtualFileSystem"/> that represents the flattened version of the specified list of <see cref="IVirtualFileSystem"/> instances.
/// </returns>
public static IVirtualFileSystem Create(params IVirtualFileSystem[] list) =>
list.Length != 1
? Create(list.AsEnumerable())
: Flatten(list[0]);

/// <summary>
/// Creates an instance of the <see cref="IVirtualFileSystem"/> from the specified list and flattens it into a flat list of file systems.
/// Creates an <see cref="IVirtualFileSystem"/> from the specified list, flattening any nested <see cref="CompositeFileSystem"/> instances.
/// </summary>
/// <remarks>
/// This method returns a <see cref="CompositeFileSystem"/> if more than one file system remains after flattening.
/// </remarks>
/// <param name="list">The list of <see cref="IVirtualFileSystem"/> instances to compose and flatten.</param>
/// <returns>
/// A <see cref="IVirtualFileSystem"/> that represents the flattened version of the specified list of the <see cref="IVirtualFileSystem"/>.
/// An <see cref="IVirtualFileSystem"/> that represents the flattened version of the specified list of <see cref="IVirtualFileSystem"/> instances.
/// </returns>
public static IVirtualFileSystem Create(IEnumerable<IVirtualFileSystem> list)
{
Expand Down
2 changes: 1 addition & 1 deletion src/Ramstack.FileSystem.Globbing/Internal/PathHelper.cs
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ internal static class PathHelper
/// <summary>
/// Determines whether the specified path matches any of the specified patterns.
/// </summary>
/// <param name="path">The path to match for a match.</param>
/// <param name="path">The path to test for a match.</param>
/// <param name="patterns">An array of patterns to match against the path.</param>
/// <returns>
/// <see langword="true" /> if the path matches any of the patterns;
Expand Down
2 changes: 1 addition & 1 deletion src/Ramstack.FileSystem.Physical/PhysicalDirectory.cs
Original file line number Diff line number Diff line change
Expand Up @@ -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.
}

Expand Down
4 changes: 2 additions & 2 deletions src/Ramstack.FileSystem.Physical/PhysicalFile.cs
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ internal PhysicalFile(PhysicalFileSystem fileSystem, string path, string physica
/// <inheritdoc />
protected override ValueTask<Stream> 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
Expand Down Expand Up @@ -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.
}

Expand Down
2 changes: 1 addition & 1 deletion src/Ramstack.FileSystem.Readonly/ReadonlyDirectory.cs
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ internal sealed class ReadonlyDirectory : VirtualDirectory
/// <summary>
/// Initializes a new instance of the <see cref="ReadonlyDirectory"/> class.
/// </summary>
/// <param name="fileSystem">The file system associated with this file.</param>
/// <param name="fileSystem">The file system associated with this directory.</param>
/// <param name="directory">The <see cref="VirtualDirectory"/> instance to wrap.</param>
public ReadonlyDirectory(ReadonlyFileSystem fileSystem, VirtualDirectory directory) : base(directory.FullName) =>
(_fs, _directory) = (fileSystem, directory);
Expand Down
2 changes: 1 addition & 1 deletion src/Ramstack.FileSystem.Sub/SubDirectory.cs
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ internal sealed class SubDirectory : VirtualDirectory
/// Initializes a new instance of the <see cref="SubDirectory"/> class.
/// </summary>
/// <param name="fileSystem">The file system associated with this directory.</param>
/// <param name="path">The path of the file.</param>
/// <param name="path">The path of the directory.</param>
/// <param name="directory">The underlying <see cref="VirtualDirectory"/> instance to wrap.</param>
public SubDirectory(SubFileSystem fileSystem, string path, VirtualDirectory directory) : base(path) =>
(_fs, _directory) = (fileSystem, directory);
Expand Down
Loading