diff --git a/src/Cake.Issues.DocFx/DocFxIssuesProvider.cs b/src/Cake.Issues.DocFx/DocFxIssuesProvider.cs index 6b244bf47..c0fc75cf5 100644 --- a/src/Cake.Issues.DocFx/DocFxIssuesProvider.cs +++ b/src/Cake.Issues.DocFx/DocFxIssuesProvider.cs @@ -84,7 +84,7 @@ private static IssuePriority GetPriority(string severity) } /// - /// Reads the affected line from a issue logged in a DocFx log file. + /// Reads the affected line from an issue logged in a DocFx log file. /// /// The line in the current log entry. /// The line of the issue. @@ -101,7 +101,7 @@ private static IssuePriority GetPriority(string severity) } /// - /// Reads the affected file path from a issue logged in a DocFx log file. + /// Reads the affected file path from an issue logged in a DocFx log file. /// /// The file name in the current log entry. /// Absolute path to the root of the DocFx project. diff --git a/src/Cake.Issues.EsLint/EsLintIssuesAliases.IssueProvider.cs b/src/Cake.Issues.EsLint/EsLintIssuesAliases.IssueProvider.cs index 649bd8675..a1f55a406 100644 --- a/src/Cake.Issues.EsLint/EsLintIssuesAliases.IssueProvider.cs +++ b/src/Cake.Issues.EsLint/EsLintIssuesAliases.IssueProvider.cs @@ -29,7 +29,7 @@ public static string EsLintIssuesProviderTypeName( /// Gets an instance of a provider for issues reported by ESLint using a log file from disk. /// /// The context. - /// Path to the the ESLint log file. + /// Path to the ESLint log file. /// The log file needs to be in the format as defined by the parameter. /// Format of the provided ESLint log file. /// Instance of a provider for issues reported by ESLint. @@ -62,7 +62,7 @@ public static IIssueProvider EsLintIssuesFromFilePath( /// Gets an instance of a provider for issues reported by ESLint using log file content. /// /// The context. - /// Content of the the ESLint log file. + /// Content of the ESLint log file. /// The log file needs to be in the format as defined by the parameter. /// Format of the provided ESLint log file. /// Instance of a provider for issues reported by ESLint. diff --git a/src/Cake.Issues.EsLint/EsLintIssuesSettings.cs b/src/Cake.Issues.EsLint/EsLintIssuesSettings.cs index f313d4d8f..889282c85 100644 --- a/src/Cake.Issues.EsLint/EsLintIssuesSettings.cs +++ b/src/Cake.Issues.EsLint/EsLintIssuesSettings.cs @@ -11,7 +11,7 @@ public class EsLintIssuesSettings : BaseMultiFormatIssueProviderSettings class /// for reading a log file on disk. /// - /// Path to the the ESLint log file. + /// Path to the ESLint log file. /// The log file needs to be in the format as defined by the parameter. /// Format of the provided ESLint log file. public EsLintIssuesSettings(FilePath logFilePath, BaseEsLintLogFileFormat format) @@ -23,7 +23,7 @@ public EsLintIssuesSettings(FilePath logFilePath, BaseEsLintLogFileFormat format /// Initializes a new instance of the class /// for a log file content in memory. /// - /// Content of the the ESLint log file. + /// Content of the ESLint log file. /// The log file needs to be in the format as defined by the parameter. /// Format of the provided ESLint log file. public EsLintIssuesSettings(byte[] logFileContent, BaseEsLintLogFileFormat format) diff --git a/src/Cake.Issues.EsLint/EsLintRuleUrlResolver.cs b/src/Cake.Issues.EsLint/EsLintRuleUrlResolver.cs index 83ea1a26c..7cf2a94e0 100644 --- a/src/Cake.Issues.EsLint/EsLintRuleUrlResolver.cs +++ b/src/Cake.Issues.EsLint/EsLintRuleUrlResolver.cs @@ -3,7 +3,7 @@ using System; /// - /// Class for retrieving an URL linking to a site describing a rule. + /// Class for retrieving a URL linking to a site describing a rule. /// internal class EsLintRuleUrlResolver : BaseRuleUrlResolver { diff --git a/src/Cake.Issues.InspectCode/Extensions.cs b/src/Cake.Issues.InspectCode/Extensions.cs index 137b1c6f4..3a0f00f56 100644 --- a/src/Cake.Issues.InspectCode/Extensions.cs +++ b/src/Cake.Issues.InspectCode/Extensions.cs @@ -8,7 +8,7 @@ internal static class Extensions { /// - /// Returns an for an URL string. + /// Returns an for a URL string. /// /// URL to convert. /// created from . diff --git a/src/Cake.Issues.InspectCode/InspectCodeIssuesProvider.cs b/src/Cake.Issues.InspectCode/InspectCodeIssuesProvider.cs index db2434d49..40602c9e2 100644 --- a/src/Cake.Issues.InspectCode/InspectCodeIssuesProvider.cs +++ b/src/Cake.Issues.InspectCode/InspectCodeIssuesProvider.cs @@ -93,7 +93,7 @@ protected override IEnumerable InternalReadIssues() } /// - /// Determines the project for a issue logged in a Inspect Code log. + /// Determines the project for an issue logged in an Inspect Code log. /// /// Issue element from Inspect Code log. /// Returns project. @@ -126,7 +126,7 @@ private static bool TryGetProject( } /// - /// Reads the affected file path from an issue logged in a Inspect Code log. + /// Reads the affected file path from an issue logged in an Inspect Code log. /// /// Issue element from Inspect Code log. /// Path to the solution file. @@ -155,7 +155,7 @@ private static bool TryGetFile(XElement issue, string solutionPath, out string f } /// - /// Reads the affected line from an issue logged in a Inspect Code log. + /// Reads the affected line from an issue logged in an Inspect Code log. /// /// Issue element from Inspect Code log. /// Returns line. @@ -189,7 +189,7 @@ private static bool TryGetLine(XElement issue, out int line) } /// - /// Reads the rule code from an issue logged in a Inspect Code log. + /// Reads the rule code from an issue logged in an Inspect Code log. /// /// Issue element from Inspect Code log. /// Returns the code of the rule. @@ -214,7 +214,7 @@ private static bool TryGetRuleId(XElement issue, out string ruleId) } /// - /// Reads the message from an issue logged in a Inspect Code log. + /// Reads the message from an issue logged in an Inspect Code log. /// /// Issue element from Inspect Code log. /// Returns the message of the issue. diff --git a/src/Cake.Issues.Markdownlint/MarkdownlintIssuesAliases.IssueProvider.cs b/src/Cake.Issues.Markdownlint/MarkdownlintIssuesAliases.IssueProvider.cs index b91f2f944..f7e6a1312 100644 --- a/src/Cake.Issues.Markdownlint/MarkdownlintIssuesAliases.IssueProvider.cs +++ b/src/Cake.Issues.Markdownlint/MarkdownlintIssuesAliases.IssueProvider.cs @@ -29,7 +29,7 @@ public static string MarkdownlintIssuesProviderTypeName( /// Gets an instance of a provider for issues reported by Markdownlint using a log file from disk. /// /// The context. - /// Path to the the Markdownlint log file. + /// Path to the Markdownlint log file. /// The log file needs to be in the format as defined by the parameter. /// Format of the provided Markdownlint log file. /// Instance of a provider for issues reported by Markdownlint. @@ -64,7 +64,7 @@ public static IIssueProvider MarkdownlintIssuesFromFilePath( /// Gets an instance of a provider for issues reported by Markdownlint using log file content. /// /// The context. - /// Content of the the Markdownlint log file. + /// Content of the Markdownlint log file. /// The log file needs to be in the format as defined by the parameter. /// Format of the provided Markdownlint log file. /// Instance of a provider for issues reported by Markdownlint. diff --git a/src/Cake.Issues.Markdownlint/MarkdownlintIssuesAliases.RuleUrlResolver.cs b/src/Cake.Issues.Markdownlint/MarkdownlintIssuesAliases.RuleUrlResolver.cs index 2c372474e..3bc22b4dd 100644 --- a/src/Cake.Issues.Markdownlint/MarkdownlintIssuesAliases.RuleUrlResolver.cs +++ b/src/Cake.Issues.Markdownlint/MarkdownlintIssuesAliases.RuleUrlResolver.cs @@ -16,7 +16,7 @@ public static partial class MarkdownlintIssuesAliases /// Resolver which returns an linking to a site /// containing help for a specific . /// - /// Adds a provider with default priority of 0 returning a link for all rules with Id smaller than 20 to + /// Adds a provider with default priority of 0 returning a link for all rules with ID smaller than 20 to /// search with Google for the rule: /// /// Priority of the resolver. Resolver with a higher priority are considered /// first during resolving of the URL. /// - /// Adds a provider of priority 5 returning a link for all rules with Id smaller than 20 to + /// Adds a provider of priority 5 returning a link for all rules with ID smaller than 20 to /// search with Google for the rule: /// /// - /// Class for retrieving an URL linking to a site describing a rule. + /// Class for retrieving a URL linking to a site describing a rule. /// internal class MarkdownlintRuleUrlResolver : BaseRuleUrlResolver { diff --git a/src/Cake.Issues.MsBuild/MsBuildIssuesAliases.IssueProvider.cs b/src/Cake.Issues.MsBuild/MsBuildIssuesAliases.IssueProvider.cs index 4209fc41b..b71b21e1f 100644 --- a/src/Cake.Issues.MsBuild/MsBuildIssuesAliases.IssueProvider.cs +++ b/src/Cake.Issues.MsBuild/MsBuildIssuesAliases.IssueProvider.cs @@ -29,7 +29,7 @@ public static string MsBuildIssuesProviderTypeName( /// Gets an instance of a provider for issues reported as MsBuild warnings using a log file from disk. /// /// The context. - /// Path to the the MsBuild log file. + /// Path to the MsBuild log file. /// The log file needs to be in the format as defined by the parameter. /// Format of the provided MsBuild log file. /// Instance of a provider for issues reported as MsBuild warnings. @@ -64,7 +64,7 @@ public static IIssueProvider MsBuildIssuesFromFilePath( /// Gets an instance of a provider for issues reported as MsBuild warnings using log content. /// /// The context. - /// Content of the the MsBuild log file. + /// Content of the MsBuild log file. /// The log file needs to be in the format as defined by the parameter. /// Format of the provided MsBuild log file. /// Instance of a provider for issues reported as MsBuild warnings. diff --git a/src/Cake.Issues.MsBuild/MsBuildIssuesAliases.XmlFileLoggerLogFileFormat.cs b/src/Cake.Issues.MsBuild/MsBuildIssuesAliases.XmlFileLoggerLogFileFormat.cs index dd63844a7..a837e1aa6 100644 --- a/src/Cake.Issues.MsBuild/MsBuildIssuesAliases.XmlFileLoggerLogFileFormat.cs +++ b/src/Cake.Issues.MsBuild/MsBuildIssuesAliases.XmlFileLoggerLogFileFormat.cs @@ -28,7 +28,7 @@ public static partial class MsBuildIssuesAliases /// /// /// - /// In order to use the above logger, include the following in your build.cake file to download and + /// In order to use the above logger, include the following in your build.cake file to download and /// install from NuGet.org: /// /// #tool "nuget:?package=MSBuild.Extension.Pack" diff --git a/src/Cake.Issues.MsBuild/MsBuildRuleUrlResolver.cs b/src/Cake.Issues.MsBuild/MsBuildRuleUrlResolver.cs index 0192428ca..6621a8067 100644 --- a/src/Cake.Issues.MsBuild/MsBuildRuleUrlResolver.cs +++ b/src/Cake.Issues.MsBuild/MsBuildRuleUrlResolver.cs @@ -4,7 +4,7 @@ using System.Text; /// - /// Class for retrieving an URL linking to a site describing a rule. + /// Class for retrieving a URL linking to a site describing a rule. /// internal class MsBuildRuleUrlResolver : BaseRuleUrlResolver { @@ -51,7 +51,7 @@ private MsBuildRuleUrlResolver() /// protected override bool TryGetRuleDescription(string rule, MsBuildRuleDescription ruleDescription) { - // Parse the rule. Expect it in the form starting with a identifier containing characters + // Parse the rule. Expect it in the form starting with an identifier containing characters // followed by the rule id as a number. var digitIndex = -1; var categoryBuilder = new StringBuilder(); diff --git a/src/Cake.Issues.PullRequests.AppVeyor/AppVeyorPullRequestSystem.cs b/src/Cake.Issues.PullRequests.AppVeyor/AppVeyorPullRequestSystem.cs index a3af0a6b8..dddfd0ab2 100644 --- a/src/Cake.Issues.PullRequests.AppVeyor/AppVeyorPullRequestSystem.cs +++ b/src/Cake.Issues.PullRequests.AppVeyor/AppVeyorPullRequestSystem.cs @@ -17,7 +17,7 @@ public class AppVeyorPullRequestSystem : BasePullRequestSystem /// Initializes a new instance of the class. /// /// The Cake context. - /// Settings for writting issues to AppVeyor. + /// Settings for writing issues to AppVeyor. public AppVeyorPullRequestSystem(ICakeContext context, AppVeyorBuildSettings settings) : base(context?.Log ?? throw new ArgumentNullException(nameof(context))) { diff --git a/src/Cake.Issues.PullRequests.AzureDevOps/AzureDevOpsPullRequestSystemAliases.PullRequestSystem.cs b/src/Cake.Issues.PullRequests.AzureDevOps/AzureDevOpsPullRequestSystemAliases.PullRequestSystem.cs index acf2ce0bf..3178cdffc 100644 --- a/src/Cake.Issues.PullRequests.AzureDevOps/AzureDevOpsPullRequestSystemAliases.PullRequestSystem.cs +++ b/src/Cake.Issues.PullRequests.AzureDevOps/AzureDevOpsPullRequestSystemAliases.PullRequestSystem.cs @@ -16,7 +16,7 @@ public static partial class AzureDevOpsPullRequestSystemAliases /// /// The context. /// Full URL of the Git repository, - /// eg. http://myserver:8080/tfs/defaultcollection/myproject/_git/myrepository. + /// e.g. http://myserver:8080/tfs/defaultcollection/myproject/_git/myrepository. /// Supported URL schemes are HTTP, HTTPS and SSH. /// URLs using SSH scheme are converted to HTTPS. /// Branch for which the pull request is made. @@ -59,7 +59,7 @@ public static IPullRequestSystem AzureDevOpsPullRequests( /// /// The context. /// Full URL of the Git repository, - /// eg. http://myserver:8080/tfs/defaultcollection/myproject/_git/myrepository. + /// e.g. http://myserver:8080/tfs/defaultcollection/myproject/_git/myrepository. /// Supported URL schemes are HTTP, HTTPS and SSH. /// URLs using SSH scheme are converted to HTTPS. /// ID of the pull request. diff --git a/src/Cake.Issues.PullRequests.AzureDevOps/AzureDevOpsPullRequestSystemSettings.cs b/src/Cake.Issues.PullRequests.AzureDevOps/AzureDevOpsPullRequestSystemSettings.cs index 31e54202d..716c42c81 100644 --- a/src/Cake.Issues.PullRequests.AzureDevOps/AzureDevOpsPullRequestSystemSettings.cs +++ b/src/Cake.Issues.PullRequests.AzureDevOps/AzureDevOpsPullRequestSystemSettings.cs @@ -13,7 +13,7 @@ public class AzureDevOpsPullRequestSystemSettings : AzureDevOpsPullRequestSettin /// Initializes a new instance of the class. /// /// Full URL of the Git repository, - /// eg. http://myserver:8080/tfs/defaultcollection/myproject/_git/myrepository. + /// e.g. http://myserver:8080/tfs/defaultcollection/myproject/_git/myrepository. /// Supported URL schemes are HTTP, HTTPS and SSH. /// URLs using SSH scheme are converted to HTTPS. /// Branch for which the pull request is made. @@ -27,7 +27,7 @@ public AzureDevOpsPullRequestSystemSettings(Uri repositoryUrl, string sourceBran /// Initializes a new instance of the class. /// /// Full URL of the Git repository, - /// eg. http://myserver:8080/tfs/defaultcollection/myproject/_git/myrepository. + /// e.g. http://myserver:8080/tfs/defaultcollection/myproject/_git/myrepository. /// Supported URL schemes are HTTP, HTTPS and SSH. /// URLs using SSH scheme are converted to HTTPS. /// ID of the pull request. @@ -67,8 +67,8 @@ public AzureDevOpsPullRequestSystemSettings() } /// - /// Gets or sets a value indicating whether pull request system should check if commit Id - /// is still up to date before posting comments. + /// Gets or sets a value indicating whether pull request system should check if commit ID + /// is still up-to-date before posting comments. /// Default value is true. /// // ReSharper disable once AutoPropertyCanBeMadeGetOnly.Global diff --git a/src/Cake.Issues.PullRequests.GitHubActions/GitHubActionsPullRequestSystem.cs b/src/Cake.Issues.PullRequests.GitHubActions/GitHubActionsPullRequestSystem.cs index f1e3049b0..d87622073 100644 --- a/src/Cake.Issues.PullRequests.GitHubActions/GitHubActionsPullRequestSystem.cs +++ b/src/Cake.Issues.PullRequests.GitHubActions/GitHubActionsPullRequestSystem.cs @@ -59,8 +59,8 @@ protected override void InternalPostDiscussionThreads(IEnumerable issues /// /// The root path of the file, relative to the repository root. /// The file path relative to the project root. - /// The line where the issue ocurred. - /// The column where the issue ocurred. + /// The line where the issue occurred. + /// The column where the issue occurred. /// Formatted options string for the warning service message. private static string FormatWarningOptions(DirectoryPath rootDirectoryPath, FilePath filePath, int? line, int? column) { @@ -85,7 +85,7 @@ private static string FormatWarningOptions(DirectoryPath rootDirectoryPath, File } /// - /// Writes services messages to report issues to GitHub Actions grouped by provider and run. + /// Writes service messages to report issues to GitHub Actions grouped by provider and run. /// /// Issues which should be reported. private void WriteGroupedIssues(IEnumerable issues) diff --git a/src/Cake.Issues.PullRequests/IPullRequestDiscussionThread.cs b/src/Cake.Issues.PullRequests/IPullRequestDiscussionThread.cs index 5d4ff5073..d3e81463b 100644 --- a/src/Cake.Issues.PullRequests/IPullRequestDiscussionThread.cs +++ b/src/Cake.Issues.PullRequests/IPullRequestDiscussionThread.cs @@ -36,7 +36,7 @@ public interface IPullRequestDiscussionThread string CommentSource { get; set; } /// - /// Gets or sets a the provider type which reported the issue. + /// Gets or sets the provider type which reported the issue. /// This value is used to identify the comment in subsequent runs. /// string ProviderType { get; set; } diff --git a/src/Cake.Issues.PullRequests/ISupportCheckingCommitId.cs b/src/Cake.Issues.PullRequests/ISupportCheckingCommitId.cs index 1c83c87ac..0f3ee541f 100644 --- a/src/Cake.Issues.PullRequests/ISupportCheckingCommitId.cs +++ b/src/Cake.Issues.PullRequests/ISupportCheckingCommitId.cs @@ -1,7 +1,7 @@ namespace Cake.Issues.PullRequests { /// - /// Interface describing that a pull request system supports checking if commit Id is still up to date. + /// Interface describing that a pull request system supports checking if commit ID is still up-to-date. /// public interface ISupportCheckingCommitId : IPullRequestSystemCapability diff --git a/src/Cake.Issues.PullRequests/IssueFilterer.cs b/src/Cake.Issues.PullRequests/IssueFilterer.cs index 22587ec49..a2df864f1 100644 --- a/src/Cake.Issues.PullRequests/IssueFilterer.cs +++ b/src/Cake.Issues.PullRequests/IssueFilterer.cs @@ -201,7 +201,7 @@ private IList FilterPreExistingComments( } /// - /// Limits the number of issues so as to not overload the pull request with too many comments. + /// Limits the number of issues to not overload the pull request with too many comments. /// /// List of issues which should be filtered. /// List of threads which were reported by Cake.Issues. diff --git a/src/Cake.Issues.PullRequests/Orchestrator.cs b/src/Cake.Issues.PullRequests/Orchestrator.cs index 4768b9a90..350edbb30 100644 --- a/src/Cake.Issues.PullRequests/Orchestrator.cs +++ b/src/Cake.Issues.PullRequests/Orchestrator.cs @@ -276,7 +276,7 @@ private Dictionary GetCommentsForIssue( /// /// Returns all matching comments from discussion threads for an issue. - /// Comments are considered matching if they fulfill all of the following conditions: + /// Comments are considered matching if they fulfill the following conditions: /// * The thread is active. /// * The thread is for the same file. /// * The thread was created by the same logic, i.e. the same . diff --git a/src/Cake.Issues.Reporting.Console/ConsoleIssueReportFormatSettings.cs b/src/Cake.Issues.Reporting.Console/ConsoleIssueReportFormatSettings.cs index 35d4c4748..9850a391d 100644 --- a/src/Cake.Issues.Reporting.Console/ConsoleIssueReportFormatSettings.cs +++ b/src/Cake.Issues.Reporting.Console/ConsoleIssueReportFormatSettings.cs @@ -12,7 +12,7 @@ public class ConsoleIssueReportFormatSettings public bool ShowDiagnostics { get; set; } = true; /// - /// Gets or sets a value indicating whether or not the report should be rendered in compact mode. + /// Gets or sets a value indicating whether the report should be rendered in compact mode. /// Default value is false. /// public bool Compact { get; set; } diff --git a/src/Cake.Issues.Reporting.Generic/GenericIssueReportFormatAliases.cs b/src/Cake.Issues.Reporting.Generic/GenericIssueReportFormatAliases.cs index 0c503a9b1..89e4c8c4f 100644 --- a/src/Cake.Issues.Reporting.Generic/GenericIssueReportFormatAliases.cs +++ b/src/Cake.Issues.Reporting.Generic/GenericIssueReportFormatAliases.cs @@ -19,11 +19,11 @@ public static class GenericIssueReportFormatAliases { /// - /// Gets an instance of a the generic report format using an embedded template. + /// Gets an instance of the generic report format using an embedded template. /// /// The context. /// Template to use for generating the report. - /// Instance of a the generic report format. + /// Instance of the generic report format. /// /// Create HTML report using the diagnostic template: /// @@ -48,12 +48,12 @@ public static IIssueReportFormat GenericIssueReportFormatFromEmbeddedTemplate( } /// - /// Gets an instance of a the generic report format using an embedded template with custom settings. + /// Gets an instance of the generic report format using an embedded template with custom settings. /// /// The context. /// Template to use for generating the report. /// Action for defining the settings. - /// Instance of a the generic report format. + /// Instance of the generic report format. /// /// Create HTML report using the HtmlDxDataGrid template with custom title: /// @@ -84,11 +84,11 @@ public static IIssueReportFormat GenericIssueReportFormatFromEmbeddedTemplate( } /// - /// Gets an instance of a the generic report format using a local template. + /// Gets an instance of the generic report format using a local template. /// /// The context. /// Path to the template to use for generating the report. - /// Instance of a the generic report format. + /// Instance of the generic report format. /// /// Create HTML report from local template file: /// @@ -114,12 +114,12 @@ public static IIssueReportFormat GenericIssueReportFormatFromFilePath( } /// - /// Gets an instance of a the generic report format using a local template with custom settings. + /// Gets an instance of the generic report format using a local template with custom settings. /// /// The context. /// Path to the template to use for generating the report. /// Action for defining the settings. - /// Instance of a the generic report format. + /// Instance of the generic report format. /// /// Create HTML report from local template file with custom title: /// @@ -151,11 +151,11 @@ public static IIssueReportFormat GenericIssueReportFormatFromFilePath( } /// - /// Gets an instance of a the generic report format using a template string. + /// Gets an instance of the generic report format using a template string. /// /// The context. /// Content of the template to use for generating the report. - /// Instance of a the generic report format. + /// Instance of the generic report format. /// /// Create HTML report from a template string: /// @@ -183,12 +183,12 @@ public static IIssueReportFormat GenericIssueReportFormatFromContent( } /// - /// Gets an instance of a the generic report format using a template string with custom settings. + /// Gets an instance of the generic report format using a template string with custom settings. /// /// The context. /// Content of the template to use for generating the report. /// Action for defining the settings. - /// Instance of a the generic report format. + /// Instance of the generic report format. /// /// Create HTML report from a template string with custom title: /// @@ -222,11 +222,11 @@ public static IIssueReportFormat GenericIssueReportFormatFromContent( } /// - /// Gets an instance of a the generic report format using specified settings. + /// Gets an instance of the generic report format using specified settings. /// /// The context. /// Settings for reading the MSBuild log. - /// Instance of a the generic report format. + /// Instance of the generic report format. /// /// Create HTML report: /// diff --git a/src/Cake.Issues.Reporting.Generic/GenericIssueReportTemplate.cs b/src/Cake.Issues.Reporting.Generic/GenericIssueReportTemplate.cs index fb1a5ec34..e720b9ecb 100644 --- a/src/Cake.Issues.Reporting.Generic/GenericIssueReportTemplate.cs +++ b/src/Cake.Issues.Reporting.Generic/GenericIssueReportTemplate.cs @@ -6,17 +6,17 @@ public enum GenericIssueReportTemplate { /// - /// Template for a HTML report containing a list of all issues with all properties. + /// Template for an HTML report containing a list of all issues with all properties. /// HtmlDiagnostic, /// - /// Template for a HTML report containing a rich data table view with sorting and search functionality. + /// Template for an HTML report containing a rich data table view with sorting and search functionality. /// HtmlDataTable, /// - /// Template for a HTML report containing a rich data grid with sorting, filtering, grouping and search capabilities. + /// Template for an HTML report containing a rich data grid with sorting, filtering, grouping and search capabilities. /// See for template specific options. /// HtmlDxDataGrid, diff --git a/src/Cake.Issues.Reporting.Generic/HtmlDxDataGridColumnDescription.cs b/src/Cake.Issues.Reporting.Generic/HtmlDxDataGridColumnDescription.cs index 0e9ada2a2..8d59d1850 100644 --- a/src/Cake.Issues.Reporting.Generic/HtmlDxDataGridColumnDescription.cs +++ b/src/Cake.Issues.Reporting.Generic/HtmlDxDataGridColumnDescription.cs @@ -10,7 +10,7 @@ public class HtmlDxDataGridColumnDescription /// /// Initializes a new instance of the class. /// - /// Id of the column. + /// ID of the column. /// Function for retrieving the value of the column. public HtmlDxDataGridColumnDescription(string id, Func valueRetriever) { diff --git a/src/Cake.Issues.Reporting.Generic/IIssueExtensions.cs b/src/Cake.Issues.Reporting.Generic/IIssueExtensions.cs index a54cde9ba..774bbc54f 100644 --- a/src/Cake.Issues.Reporting.Generic/IIssueExtensions.cs +++ b/src/Cake.Issues.Reporting.Generic/IIssueExtensions.cs @@ -13,7 +13,7 @@ public static class IIssueExtensions { /// - /// Returns an dynamic object containing the properties of an issue. + /// Returns a dynamic object containing the properties of an issue. /// /// Issue for which the dynamic object should be returned. /// Flag if value of should be added. diff --git a/src/Cake.Issues.Reporting.Generic/IdeIntegrationSettings.cs b/src/Cake.Issues.Reporting.Generic/IdeIntegrationSettings.cs index 3292b9955..ef9e5c41e 100644 --- a/src/Cake.Issues.Reporting.Generic/IdeIntegrationSettings.cs +++ b/src/Cake.Issues.Reporting.Generic/IdeIntegrationSettings.cs @@ -16,7 +16,7 @@ public class IdeIntegrationSettings public string OpenInIdeCall { get; set; } /// - /// Gets or sets text which should be shown in the drop down menu for opening the file affected + /// Gets or sets text which should be shown in the dropdown menu for opening the file affected /// by an issue in an IDE. /// Default value is Open in IDE. /// diff --git a/src/Cake.Issues.Reporting.Generic/UriExtensions.cs b/src/Cake.Issues.Reporting.Generic/UriExtensions.cs index 5af4f7173..1ba506d53 100644 --- a/src/Cake.Issues.Reporting.Generic/UriExtensions.cs +++ b/src/Cake.Issues.Reporting.Generic/UriExtensions.cs @@ -10,7 +10,7 @@ internal static class UriExtensions { /// - /// Appends paths to an URI. + /// Appends paths to a URI. /// /// URI to which the paths should be appended. /// Paths to append. diff --git a/src/Cake.Issues.Reporting.Sarif.Tests/SarifIssueReportFixture.cs b/src/Cake.Issues.Reporting.Sarif.Tests/SarifIssueReportFixture.cs index 4c27ff02c..c16db60ca 100644 --- a/src/Cake.Issues.Reporting.Sarif.Tests/SarifIssueReportFixture.cs +++ b/src/Cake.Issues.Reporting.Sarif.Tests/SarifIssueReportFixture.cs @@ -66,7 +66,7 @@ public void TestReportCreation(Action settings) }); // Then - // Currently only checks if genertions failed or not without checking actual output. + // Currently only checks if generation failed or not without checking actual output. result.ShouldNotBeNull(); } } diff --git a/src/Cake.Issues.Reporting.Sarif.Tests/SarifIssueReportGeneratorTests.cs b/src/Cake.Issues.Reporting.Sarif.Tests/SarifIssueReportGeneratorTests.cs index d24ed61fd..f98d39cdc 100644 --- a/src/Cake.Issues.Reporting.Sarif.Tests/SarifIssueReportGeneratorTests.cs +++ b/src/Cake.Issues.Reporting.Sarif.Tests/SarifIssueReportGeneratorTests.cs @@ -64,7 +64,7 @@ public void Should_Generate_Report() // Issue to exercise the corner case where ruleId is absent (so no rule // metadata is created) but helpUri is present (so it is stored in the - // result's property bag. + // result's property bag). IssueBuilder .NewIssue("Message Bar 2.", "ProviderType Bar", "ProviderName Bar") .InFile(@"src\Cake.Issues.Reporting.Sarif.Tests\SarifIssueReportGeneratorTests.cs", 23, 42, 5, 10) diff --git a/src/Cake.Issues.Reporting/Aliases.cs b/src/Cake.Issues.Reporting/Aliases.cs index 313121aa5..9c2fd8409 100644 --- a/src/Cake.Issues.Reporting/Aliases.cs +++ b/src/Cake.Issues.Reporting/Aliases.cs @@ -12,7 +12,7 @@ public static class Aliases { /// - /// Creates a report for a the issues from an issue provider in the specified format. + /// Creates a report for the issues from an issue provider in the specified format. /// /// The context. /// Issue provider for whose issues the report should be generated. @@ -59,7 +59,7 @@ public static FilePath CreateIssueReport( } /// - /// Creates a report for a the issues from an issue provider with the specific settings. + /// Creates a report for the issues from an issue provider with the specific settings. /// /// The context. /// Issue provider for whose issues the report should be generated. diff --git a/src/Cake.Issues.Reporting/IIssueReportFormat.cs b/src/Cake.Issues.Reporting/IIssueReportFormat.cs index 57a3031fb..84e2822aa 100644 --- a/src/Cake.Issues.Reporting/IIssueReportFormat.cs +++ b/src/Cake.Issues.Reporting/IIssueReportFormat.cs @@ -4,7 +4,7 @@ using Cake.Core.IO; /// - /// Interface describing a issue report format. + /// Interface describing an issue report format. /// public interface IIssueReportFormat : IBaseIssueComponent { diff --git a/src/Cake.Issues.Sarif/SarifIssuesProvider.cs b/src/Cake.Issues.Sarif/SarifIssuesProvider.cs index cce533f5b..1bec87eea 100644 --- a/src/Cake.Issues.Sarif/SarifIssuesProvider.cs +++ b/src/Cake.Issues.Sarif/SarifIssuesProvider.cs @@ -10,7 +10,7 @@ using Newtonsoft.Json; /// - /// Provider for issues in SARIF compatible formt. + /// Provider for issues in SARIF compatible format. /// /// The Cake log context. /// Settings for the issue provider. diff --git a/src/Cake.Issues.Terraform/TerraformIssuesProvider.cs b/src/Cake.Issues.Terraform/TerraformIssuesProvider.cs index ee421ee7f..456541c84 100644 --- a/src/Cake.Issues.Terraform/TerraformIssuesProvider.cs +++ b/src/Cake.Issues.Terraform/TerraformIssuesProvider.cs @@ -111,7 +111,7 @@ private static IssuePriority GetPriority(string severity) } /// - /// Reads the affected file path from a issue logged by terraform validate. + /// Reads the affected file path from an issue logged by terraform validate. /// /// The file name in the current log entry. /// Absolute path to the root directory of the Terraform scripts. diff --git a/src/Cake.Issues.Terraform/TerraformIssuesSettings.cs b/src/Cake.Issues.Terraform/TerraformIssuesSettings.cs index 219897bf1..dfdc229aa 100644 --- a/src/Cake.Issues.Terraform/TerraformIssuesSettings.cs +++ b/src/Cake.Issues.Terraform/TerraformIssuesSettings.cs @@ -10,7 +10,7 @@ public class TerraformIssuesSettings : IssueProviderSettings /// /// Initializes a new instance of the class. /// - /// Path to the the Terraform output file. + /// Path to the Terraform output file. /// Path to the directory of the Terraform scripts. /// Either the full path or the path relative to the repository root. public TerraformIssuesSettings(FilePath validateOutputFilePath, DirectoryPath terraformRootPath) diff --git a/src/Cake.Issues/Aliases.FileLinking.cs b/src/Cake.Issues/Aliases.FileLinking.cs index ddb70f4f0..1c11db708 100644 --- a/src/Cake.Issues/Aliases.FileLinking.cs +++ b/src/Cake.Issues/Aliases.FileLinking.cs @@ -86,7 +86,7 @@ public static FileLinkSettings IssueFileLinkSettings( /// /// The context. /// Full URL of the Git repository, - /// eg. https://github.com/cake-contrib/Cake.Issues.Reporting.Generic. + /// e.g. https://github.com/cake-contrib/Cake.Issues.Reporting.Generic. /// Name of the branch on which the file linking will be based on. /// Settings for linking to files hosted in GitHub. [CakeMethodAlias] @@ -109,7 +109,7 @@ public static FileLinkSettings IssueFileLinkSettingsForGitHubBranch( /// /// The context. /// Full URL of the Git repository, - /// eg. https://github.com/cake-contrib/Cake.Issues.Reporting.Generic. + /// e.g. https://github.com/cake-contrib/Cake.Issues.Reporting.Generic. /// Name of the branch on which the file linking will be based on. /// Root path of the files. /// null if files are in the root of the repository. @@ -138,7 +138,7 @@ public static FileLinkSettings IssueFileLinkSettingsForGitHubBranch( /// /// The context. /// Full URL of the Git repository, - /// eg. https://github.com/cake-contrib/Cake.Issues.Reporting.Generic. + /// e.g. https://github.com/cake-contrib/Cake.Issues.Reporting.Generic. /// The commit id on which the file linking will be based on. /// Settings for linking to files hosted in GitHub. [CakeMethodAlias] @@ -161,7 +161,7 @@ public static FileLinkSettings IssueFileLinkSettingsForGitHubCommit( /// /// The context. /// Full URL of the Git repository, - /// eg. https://github.com/cake-contrib/Cake.Issues.Reporting.Generic. + /// e.g. https://github.com/cake-contrib/Cake.Issues.Reporting.Generic. /// The commit id on which the file linking will be based on. /// Root path of the files. /// null or if files are in the root of the repository. @@ -191,7 +191,7 @@ public static FileLinkSettings IssueFileLinkSettingsForGitHubCommit( /// /// The context. /// Full URL of the Git repository, - /// eg. https://dev.azure.com/myorganization/_git/myrepo. + /// e.g. https://dev.azure.com/myorganization/_git/myrepo. /// Name of the branch on which the file linking will be based on. /// Settings for linking files hosted on Azure DevOps or Azure DevOps Server. [CakeMethodAlias] @@ -214,7 +214,7 @@ public static FileLinkSettings IssueFileLinkSettingsForAzureDevOpsBranch( /// /// The context. /// Full URL of the Git repository, - /// eg. https://dev.azure.com/myorganization/_git/myrepo. + /// e.g. https://dev.azure.com/myorganization/_git/myrepo. /// Name of the branch on which the file linking will be based on. /// Root path of the files. /// null if files are in the root of the repository. @@ -244,7 +244,7 @@ public static FileLinkSettings IssueFileLinkSettingsForAzureDevOpsBranch( /// /// The context. /// Full URL of the Git repository, - /// eg. https://dev.azure.com/myorganization/_git/myrepo. + /// e.g. https://dev.azure.com/myorganization/_git/myrepo. /// The commit id on which the file linking will be based on. /// Settings for linking files hosted on Azure DevOps or Azure DevOps Server. [CakeMethodAlias] @@ -267,7 +267,7 @@ public static FileLinkSettings IssueFileLinkSettingsForAzureDevOpsCommit( /// /// The context. /// Full URL of the Git repository, - /// eg. https://dev.azure.com/myorganization/_git/myrepo. + /// e.g. https://dev.azure.com/myorganization/_git/myrepo. /// The commit id on which the file linking will be based on. /// Root path of the files. /// null if files are in the root of the repository. diff --git a/src/Cake.Issues/BaseRuleUrlResolver.cs b/src/Cake.Issues/BaseRuleUrlResolver.cs index a81b5e681..c0a665ec2 100644 --- a/src/Cake.Issues/BaseRuleUrlResolver.cs +++ b/src/Cake.Issues/BaseRuleUrlResolver.cs @@ -5,7 +5,7 @@ using System.Linq; /// - /// Base class for retrieving an URL linking to a site containing help for a rule. + /// Base class for retrieving a URL linking to a site containing help for a rule. /// /// Type of the rule description. public abstract class BaseRuleUrlResolver @@ -40,7 +40,7 @@ public void AddUrlResolver(Func resolver, int priority) } /// - /// Returns an URL linking to a site describing a specific rule. + /// Returns a URL linking to a site describing a specific rule. /// /// Code of the rule for which the URL should be retrieved. /// URL linking to a site describing the rule, or null if @@ -67,7 +67,7 @@ public Uri ResolveRuleUrl(string rule) /// /// Rule which should be parsed. /// Description of the rule. - /// true if rule could by parsed successfully, otherwise false. + /// true if rule could be parsed successfully, otherwise false. protected abstract bool TryGetRuleDescription(string rule, T ruleDescription); } } \ No newline at end of file diff --git a/src/Cake.Issues/ByteArrayExtensions.cs b/src/Cake.Issues/ByteArrayExtensions.cs index 8f51140d8..f9d32040c 100644 --- a/src/Cake.Issues/ByteArrayExtensions.cs +++ b/src/Cake.Issues/ByteArrayExtensions.cs @@ -9,7 +9,7 @@ public static class ByteArrayExtensions { /// - /// Removes the BOM of an UTF-8 encoded byte array. + /// Removes the BOM of a UTF-8 encoded byte array. /// /// UTF-8 encoded byte array. /// UTF-8 encoded byte array without BOM. @@ -21,7 +21,7 @@ public static byte[] RemovePreamble(this byte[] value) } /// - /// Removes the preamble from an byte array. + /// Removes the preamble from a byte array. /// /// Byte array. /// Encoding of the byte array. @@ -42,7 +42,7 @@ public static byte[] RemovePreamble(this byte[] value, Encoding encoding) } /// - /// Converts a byte array of an UTF-8 encoded string to a string. + /// Converts a byte array of a UTF-8 encoded string to a string. /// /// Value to convert. /// Converted string. @@ -54,7 +54,7 @@ public static string ToStringUsingEncoding(this byte[] value) } /// - /// Converts a byte array of an UTF-8 encoded string to a string. + /// Converts a byte array of a UTF-8 encoded string to a string. /// /// Value to convert. /// True if contains a BOM which should not be returned. diff --git a/src/Cake.Issues/FileLinkSettings.cs b/src/Cake.Issues/FileLinkSettings.cs index 08cd82fa3..ce7a3bff1 100644 --- a/src/Cake.Issues/FileLinkSettings.cs +++ b/src/Cake.Issues/FileLinkSettings.cs @@ -54,7 +54,7 @@ public static FileLinkSettings ForAction(Func builder) /// Returns builder class for settings for linking to files hosted in GitHub. /// /// Full URL of the Git repository, - /// eg. https://github.com/cake-contrib/Cake.Issues. + /// e.g. https://github.com/cake-contrib/Cake.Issues. /// Builder class for the settings. public static GitHubFileLinkSettingsBuilder ForGitHub(Uri repositoryUrl) { diff --git a/src/Cake.Issues/FileLinking/AzureDevOpsFileLinkSettingsBuilder.cs b/src/Cake.Issues/FileLinking/AzureDevOpsFileLinkSettingsBuilder.cs index 1351a7f58..5597b44c2 100644 --- a/src/Cake.Issues/FileLinking/AzureDevOpsFileLinkSettingsBuilder.cs +++ b/src/Cake.Issues/FileLinking/AzureDevOpsFileLinkSettingsBuilder.cs @@ -14,7 +14,7 @@ public class AzureDevOpsFileLinkSettingsBuilder /// Initializes a new instance of the class. /// /// Full URL of the Git repository, - /// eg. https://github.com/cake-contrib/Cake.Issues. + /// e.g. https://github.com/cake-contrib/Cake.Issues. internal AzureDevOpsFileLinkSettingsBuilder(Uri repositoryUrl) { repositoryUrl.NotNull(nameof(repositoryUrl)); diff --git a/src/Cake.Issues/FileLinking/GitHubFileLinkSettingsBuilder.cs b/src/Cake.Issues/FileLinking/GitHubFileLinkSettingsBuilder.cs index c8a6f8ccc..0a133bb43 100644 --- a/src/Cake.Issues/FileLinking/GitHubFileLinkSettingsBuilder.cs +++ b/src/Cake.Issues/FileLinking/GitHubFileLinkSettingsBuilder.cs @@ -13,7 +13,7 @@ public class GitHubFileLinkSettingsBuilder /// Initializes a new instance of the class. /// /// Full URL of the Git repository, - /// eg. https://github.com/cake-contrib/Cake.Issues. + /// e.g. https://github.com/cake-contrib/Cake.Issues. internal GitHubFileLinkSettingsBuilder(Uri repositoryUrl) { repositoryUrl.NotNull(nameof(repositoryUrl)); diff --git a/src/Cake.Issues/IIssue.cs b/src/Cake.Issues/IIssue.cs index 822e9981d..383d8f897 100644 --- a/src/Cake.Issues/IIssue.cs +++ b/src/Cake.Issues/IIssue.cs @@ -36,25 +36,25 @@ public interface IIssue FilePath AffectedFileRelativePath { get; } /// - /// Gets the line in the file where the issues has occurred. + /// Gets the line in the file where the issues have occurred. /// null if the issue affects the whole file or an assembly. /// int? Line { get; } /// - /// Gets the end of the line range in the file where the issues has occurred. + /// Gets the end of the line range in the file where the issues have occurred. /// null if the issue affects the whole file, an assembly or only a single line. /// int? EndLine { get; } /// - /// Gets the column in the file where the issues has occurred. + /// Gets the column in the file where the issues have occurred. /// null if the issue affects the whole file or an assembly. /// int? Column { get; } /// - /// Gets the end of the column range in the file where the issues has occurred. + /// Gets the end of the column range in the file where the issues have occurred. /// null if the issue affects the whole file, an assembly or only a single column. /// int? EndColumn { get; } diff --git a/src/Cake.Issues/Issue.cs b/src/Cake.Issues/Issue.cs index dea1695ad..dd05a7cff 100644 --- a/src/Cake.Issues/Issue.cs +++ b/src/Cake.Issues/Issue.cs @@ -22,13 +22,13 @@ public class Issue : IIssue /// The path to the file affected by the issue. /// The path needs to be relative to the repository root. /// null or if issue is not related to a change in a file. - /// The line in the file where the issues has occurred. + /// The line in the file where the issues have occurred. /// null if the issue affects the whole file or an assembly. - /// The end of the line range in the file where the issues has occurred. + /// The end of the line range in the file where the issues have occurred. /// null if the issue affects the whole file, an assembly or only a single line. - /// The column in the file where the issues has occurred. + /// The column in the file where the issues have occurred. /// null if the issue affects the whole file or an assembly. - /// The end of the column range in the file where the issues has occurred. + /// The end of the column range in the file where the issues have occurred. /// null if the issue affects the whole file, an assembly or only a single column. /// Link to the position in the file where the issue occurred. /// null if no link is available. diff --git a/src/Cake.Issues/IssueBuilder.cs b/src/Cake.Issues/IssueBuilder.cs index bff937f2a..886e37daa 100644 --- a/src/Cake.Issues/IssueBuilder.cs +++ b/src/Cake.Issues/IssueBuilder.cs @@ -228,12 +228,12 @@ public IssueBuilder InFile(string filePath) } /// - /// Sets the path to the file affected by the issue and the line in the file where the issues has occurred. + /// Sets the path to the file affected by the issue and the line in the file where the issues have occurred. /// /// The path to the file affected by the issue. /// The path needs to be relative to the repository root. /// null or if issue is not related to a change in a file. - /// The line in the file where the issues has occurred. + /// The line in the file where the issues have occurred. /// null if the issue affects the whole file or an assembly. /// Issue Builder instance. public IssueBuilder InFile(string filePath, int? line) @@ -246,14 +246,14 @@ public IssueBuilder InFile(string filePath, int? line) } /// - /// Sets the path to the file affected by the issue and the line and column in the file where the issues has occurred. + /// Sets the path to the file affected by the issue and the line and column in the file where the issues have occurred. /// /// The path to the file affected by the issue. /// The path needs to be relative to the repository root. /// null or if issue is not related to a change in a file. - /// The line in the file where the issues has occurred. + /// The line in the file where the issues have occurred. /// null if the issue affects the whole file or an assembly. - /// The column in the file where the issues has occurred. + /// The column in the file where the issues have occurred. /// null if the issue affects the whole file or an assembly. /// Issue Builder instance. public IssueBuilder InFile(string filePath, int? line, int? column) @@ -267,18 +267,18 @@ public IssueBuilder InFile(string filePath, int? line, int? column) } /// - /// Sets the path to the file affected by the issue and the line and column in the file where the issues has occurred. + /// Sets the path to the file affected by the issue and the line and column in the file where the issues have occurred. /// /// The path to the file affected by the issue. /// The path needs to be relative to the repository root. /// null or if issue is not related to a change in a file. - /// The line in the file where the issues has occurred. + /// The line in the file where the issues have occurred. /// null if the issue affects the whole file or an assembly. - /// The end of the line range in the file where the issues has occurred. + /// The end of the line range in the file where the issues have occurred. /// null if the issue affects the whole file, an assembly or only a single line. - /// The column in the file where the issues has occurred. + /// The column in the file where the issues have occurred. /// null if the issue affects the whole file or an assembly. - /// The end of the column range in the file where the issues has occurred. + /// The end of the column range in the file where the issues have occurred. /// null if the issue affects the whole file, an assembly or only a single column. /// Issue Builder instance. public IssueBuilder InFile(string filePath, int? startLine, int? endLine, int? startColumn, int? endColumn) @@ -330,7 +330,7 @@ public IssueBuilder WithAdditionalInformation(IDictionary additi } /// - /// Sets the the link to the position in the file where the issue occurred. + /// Sets the link to the position in the file where the issue occurred. /// /// Link to the position in the file where the issue occurred. /// Issue Builder instance. diff --git a/src/Cake.Issues/UriExtensions.cs b/src/Cake.Issues/UriExtensions.cs index 2d6287cea..b95618ad7 100644 --- a/src/Cake.Issues/UriExtensions.cs +++ b/src/Cake.Issues/UriExtensions.cs @@ -10,7 +10,7 @@ internal static class UriExtensions { /// - /// Appends paths to an URI. + /// Appends paths to a URI. /// /// URI to which the paths should be appended. /// Paths to append.