Fix typos and grammar in comments (#588)

* Fix grammar in comments

* Fix typos in comments

src/Cake.Issues.DocFx/DocFxIssuesProvider.cs

@@ -84,7 +84,7 @@ private static IssuePriority GetPriority(string severity)
         }
 
         /// <summary>
-        /// 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.
         /// </summary>
         /// <param name="line">The line in the current log entry.</param>
         /// <returns>The line of the issue.</returns>
@@ -101,7 +101,7 @@ private static IssuePriority GetPriority(string severity)
         }
 
         /// <summary>
-        /// 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.
         /// </summary>
         /// <param name="fileName">The file name in the current log entry.</param>
         /// <param name="docRootPath">Absolute path to the root of the DocFx project.</param>

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.
         /// </summary>
         /// <param name="context">The context.</param>
-        /// <param name="logFilePath">Path to the the ESLint log file.
+        /// <param name="logFilePath">Path to the ESLint log file.
         /// The log file needs to be in the format as defined by the <paramref name="format"/> parameter.</param>
         /// <param name="format">Format of the provided ESLint log file.</param>
         /// <returns>Instance of a provider for issues reported by ESLint.</returns>
@@ -62,7 +62,7 @@ public static IIssueProvider EsLintIssuesFromFilePath(
         /// Gets an instance of a provider for issues reported by ESLint using log file content.
         /// </summary>
         /// <param name="context">The context.</param>
-        /// <param name="logFileContent">Content of the the ESLint log file.
+        /// <param name="logFileContent">Content of the ESLint log file.
         /// The log file needs to be in the format as defined by the <paramref name="format"/> parameter.</param>
         /// <param name="format">Format of the provided ESLint log file.</param>
         /// <returns>Instance of a provider for issues reported by ESLint.</returns>

src/Cake.Issues.EsLint/EsLintIssuesSettings.cs

@@ -11,7 +11,7 @@ public class EsLintIssuesSettings : BaseMultiFormatIssueProviderSettings<EsLintI
         /// Initializes a new instance of the <see cref="EsLintIssuesSettings"/> class
         /// for reading a log file on disk.
         /// </summary>
-        /// <param name="logFilePath">Path to the the ESLint log file.
+        /// <param name="logFilePath">Path to the ESLint log file.
         /// The log file needs to be in the format as defined by the <paramref name="format"/> parameter.</param>
         /// <param name="format">Format of the provided ESLint log file.</param>
         public EsLintIssuesSettings(FilePath logFilePath, BaseEsLintLogFileFormat format)
@@ -23,7 +23,7 @@ public EsLintIssuesSettings(FilePath logFilePath, BaseEsLintLogFileFormat format
         /// Initializes a new instance of the <see cref="EsLintIssuesSettings"/> class
         /// for a log file content in memory.
         /// </summary>
-        /// <param name="logFileContent">Content of the the ESLint log file.
+        /// <param name="logFileContent">Content of the ESLint log file.
         /// The log file needs to be in the format as defined by the <paramref name="format"/> parameter.</param>
         /// <param name="format">Format of the provided ESLint log file.</param>
         public EsLintIssuesSettings(byte[] logFileContent, BaseEsLintLogFileFormat format)

src/Cake.Issues.EsLint/EsLintRuleUrlResolver.cs

@@ -3,7 +3,7 @@
     using System;
 
     /// <summary>
-    /// Class for retrieving an URL linking to a site describing a rule.
+    /// Class for retrieving a URL linking to a site describing a rule.
     /// </summary>
     internal class EsLintRuleUrlResolver : BaseRuleUrlResolver<BaseRuleDescription>
     {

src/Cake.Issues.InspectCode/Extensions.cs

@@ -8,7 +8,7 @@
     internal static class Extensions
     {
         /// <summary>
-        /// Returns an <see cref="Uri"/> for an URL string.
+        /// Returns an <see cref="Uri"/> for a URL string.
         /// </summary>
         /// <param name="value">URL to convert.</param>
         /// <returns><see cref="Uri"/> created from <paramref name="value"/>.</returns>

src/Cake.Issues.InspectCode/InspectCodeIssuesProvider.cs

@@ -93,7 +93,7 @@ protected override IEnumerable<IIssue> InternalReadIssues()
         }
 
         /// <summary>
-        /// Determines the project for a issue logged in a Inspect Code log.
+        /// Determines the project for an issue logged in an Inspect Code log.
         /// </summary>
         /// <param name="issue">Issue element from Inspect Code log.</param>
         /// <param name="project">Returns project.</param>
@@ -126,7 +126,7 @@ private static bool TryGetProject(
         }
 
         /// <summary>
-        /// 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.
         /// </summary>
         /// <param name="issue">Issue element from Inspect Code log.</param>
         /// <param name="solutionPath">Path to the solution file.</param>
@@ -155,7 +155,7 @@ private static bool TryGetFile(XElement issue, string solutionPath, out string f
         }
 
         /// <summary>
-        /// 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.
         /// </summary>
         /// <param name="issue">Issue element from Inspect Code log.</param>
         /// <param name="line">Returns line.</param>
@@ -189,7 +189,7 @@ private static bool TryGetLine(XElement issue, out int line)
         }
 
         /// <summary>
-        /// 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.
         /// </summary>
         /// <param name="issue">Issue element from Inspect Code log.</param>
         /// <param name="ruleId">Returns the code of the rule.</param>
@@ -214,7 +214,7 @@ private static bool TryGetRuleId(XElement issue, out string ruleId)
         }
 
         /// <summary>
-        /// Reads the message from an issue logged in a Inspect Code log.
+        /// Reads the message from an issue logged in an Inspect Code log.
         /// </summary>
         /// <param name="issue">Issue element from Inspect Code log.</param>
         /// <param name="message">Returns the message of the issue.</param>

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.
         /// </summary>
         /// <param name="context">The context.</param>
-        /// <param name="logFilePath">Path to the the Markdownlint log file.
+        /// <param name="logFilePath">Path to the Markdownlint log file.
         /// The log file needs to be in the format as defined by the <paramref name="format"/> parameter.</param>
         /// <param name="format">Format of the provided Markdownlint log file.</param>
         /// <returns>Instance of a provider for issues reported by Markdownlint.</returns>
@@ -64,7 +64,7 @@ public static IIssueProvider MarkdownlintIssuesFromFilePath(
         /// Gets an instance of a provider for issues reported by Markdownlint using log file content.
         /// </summary>
         /// <param name="context">The context.</param>
-        /// <param name="logFileContent">Content of the the Markdownlint log file.
+        /// <param name="logFileContent">Content of the Markdownlint log file.
         /// The log file needs to be in the format as defined by the <paramref name="format"/> parameter.</param>
         /// <param name="format">Format of the provided Markdownlint log file.</param>
         /// <returns>Instance of a provider for issues reported by Markdownlint.</returns>

src/Cake.Issues.Markdownlint/MarkdownlintIssuesAliases.RuleUrlResolver.cs

@@ -16,7 +16,7 @@ public static partial class MarkdownlintIssuesAliases
         /// <param name="resolver">Resolver which returns an <see cref="Uri"/> linking to a site
         /// containing help for a specific <see cref="MarkdownlintRuleDescription"/>.</param>
         /// <example>
-        /// <para>Adds a provider with default priority of 0 returning a link for all rules with Id smaller than 20 to
+        /// <para>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:</para>
         /// <code>
         /// <![CDATA[
@@ -48,7 +48,7 @@ public static void MarkdownlintAddRuleUrlResolver(
         /// <param name="priority">Priority of the resolver. Resolver with a higher priority are considered
         /// first during resolving of the URL.</param>
         /// <example>
-        /// <para>Adds a provider of priority 5 returning a link for all rules with Id smaller than 20 to
+        /// <para>Adds a provider of priority 5 returning a link for all rules with ID smaller than 20 to
         /// search with Google for the rule:</para>
         /// <code>
         /// <![CDATA[

src/Cake.Issues.Markdownlint/MarkdownlintRuleUrlResolver.cs

@@ -4,7 +4,7 @@
     using System.Text.RegularExpressions;
 
     /// <summary>
-    /// Class for retrieving an URL linking to a site describing a rule.
+    /// Class for retrieving a URL linking to a site describing a rule.
     /// </summary>
     internal class MarkdownlintRuleUrlResolver : BaseRuleUrlResolver<MarkdownlintRuleDescription>
     {

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.
         /// </summary>
         /// <param name="context">The context.</param>
-        /// <param name="logFilePath">Path to the the MsBuild log file.
+        /// <param name="logFilePath">Path to the MsBuild log file.
         /// The log file needs to be in the format as defined by the <paramref name="format"/> parameter.</param>
         /// <param name="format">Format of the provided MsBuild log file.</param>
         /// <returns>Instance of a provider for issues reported as MsBuild warnings.</returns>
@@ -64,7 +64,7 @@ public static IIssueProvider MsBuildIssuesFromFilePath(
         /// Gets an instance of a provider for issues reported as MsBuild warnings using log content.
         /// </summary>
         /// <param name="context">The context.</param>
-        /// <param name="logFileContent">Content of the the MsBuild log file.
+        /// <param name="logFileContent">Content of the MsBuild log file.
         /// The log file needs to be in the format as defined by the <paramref name="format"/> parameter.</param>
         /// <param name="format">Format of the provided MsBuild log file.</param>
         /// <returns>Instance of a provider for issues reported as MsBuild warnings.</returns>

src/Cake.Issues.MsBuild/MsBuildIssuesAliases.XmlFileLoggerLogFileFormat.cs

@@ -28,7 +28,7 @@ public static partial class MsBuildIssuesAliases
         /// </code>
         /// </para>
         /// <para>
-        /// 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 <c>build.cake</c> file to download and
         /// install from NuGet.org:
         /// <code>
         /// #tool "nuget:?package=MSBuild.Extension.Pack"

src/Cake.Issues.MsBuild/MsBuildRuleUrlResolver.cs

@@ -4,7 +4,7 @@
     using System.Text;
 
     /// <summary>
-    /// Class for retrieving an URL linking to a site describing a rule.
+    /// Class for retrieving a URL linking to a site describing a rule.
     /// </summary>
     internal class MsBuildRuleUrlResolver : BaseRuleUrlResolver<MsBuildRuleDescription>
     {
@@ -51,7 +51,7 @@ private MsBuildRuleUrlResolver()
         /// <inheritdoc/>
         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();

src/Cake.Issues.PullRequests.AppVeyor/AppVeyorPullRequestSystem.cs

@@ -17,7 +17,7 @@ public class AppVeyorPullRequestSystem : BasePullRequestSystem
         /// Initializes a new instance of the <see cref="AppVeyorPullRequestSystem"/> class.
         /// </summary>
         /// <param name="context">The Cake context.</param>
-        /// <param name="settings">Settings for writting issues to AppVeyor.</param>
+        /// <param name="settings">Settings for writing issues to AppVeyor.</param>
         public AppVeyorPullRequestSystem(ICakeContext context, AppVeyorBuildSettings settings)
             : base(context?.Log ?? throw new ArgumentNullException(nameof(context)))
         {

src/Cake.Issues.PullRequests.AzureDevOps/AzureDevOpsPullRequestSystemAliases.PullRequestSystem.cs

@@ -16,7 +16,7 @@ public static partial class AzureDevOpsPullRequestSystemAliases
         /// </summary>
         /// <param name="context">The context.</param>
         /// <param name="repositoryUrl">Full URL of the Git repository,
-        /// eg. <code>http://myserver:8080/tfs/defaultcollection/myproject/_git/myrepository</code>.
+        /// e.g. <code>http://myserver:8080/tfs/defaultcollection/myproject/_git/myrepository</code>.
         /// Supported URL schemes are HTTP, HTTPS and SSH.
         /// URLs using SSH scheme are converted to HTTPS.</param>
         /// <param name="sourceBranch">Branch for which the pull request is made.</param>
@@ -59,7 +59,7 @@ public static IPullRequestSystem AzureDevOpsPullRequests(
         /// </summary>
         /// <param name="context">The context.</param>
         /// <param name="repositoryUrl">Full URL of the Git repository,
-        /// eg. <code>http://myserver:8080/tfs/defaultcollection/myproject/_git/myrepository</code>.
+        /// e.g. <code>http://myserver:8080/tfs/defaultcollection/myproject/_git/myrepository</code>.
         /// Supported URL schemes are HTTP, HTTPS and SSH.
         /// URLs using SSH scheme are converted to HTTPS.</param>
         /// <param name="pullRequestId">ID of the pull request.</param>

src/Cake.Issues.PullRequests.AzureDevOps/AzureDevOpsPullRequestSystemSettings.cs

@@ -13,7 +13,7 @@ public class AzureDevOpsPullRequestSystemSettings : AzureDevOpsPullRequestSettin
         /// Initializes a new instance of the <see cref="AzureDevOpsPullRequestSystemSettings"/> class.
         /// </summary>
         /// <param name="repositoryUrl">Full URL of the Git repository,
-        /// eg. <code>http://myserver:8080/tfs/defaultcollection/myproject/_git/myrepository</code>.
+        /// e.g. <code>http://myserver:8080/tfs/defaultcollection/myproject/_git/myrepository</code>.
         /// Supported URL schemes are HTTP, HTTPS and SSH.
         /// URLs using SSH scheme are converted to HTTPS.</param>
         /// <param name="sourceBranch">Branch for which the pull request is made.</param>
@@ -27,7 +27,7 @@ public AzureDevOpsPullRequestSystemSettings(Uri repositoryUrl, string sourceBran
         /// Initializes a new instance of the <see cref="AzureDevOpsPullRequestSystemSettings"/> class.
         /// </summary>
         /// <param name="repositoryUrl">Full URL of the Git repository,
-        /// eg. <code>http://myserver:8080/tfs/defaultcollection/myproject/_git/myrepository</code>.
+        /// e.g. <code>http://myserver:8080/tfs/defaultcollection/myproject/_git/myrepository</code>.
         /// Supported URL schemes are HTTP, HTTPS and SSH.
         /// URLs using SSH scheme are converted to HTTPS.</param>
         /// <param name="pullRequestId">ID of the pull request.</param>
@@ -67,8 +67,8 @@ public AzureDevOpsPullRequestSystemSettings()
         }
 
         /// <summary>
-        /// 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 <c>true</c>.
         /// </summary>
         // ReSharper disable once AutoPropertyCanBeMadeGetOnly.Global

src/Cake.Issues.PullRequests.GitHubActions/GitHubActionsPullRequestSystem.cs

@@ -59,8 +59,8 @@ protected override void InternalPostDiscussionThreads(IEnumerable<IIssue> issues
         /// </summary>
         /// <param name="rootDirectoryPath">The root path of the file, relative to the repository root.</param>
         /// <param name="filePath">The file path relative to the project root.</param>
-        /// <param name="line">The line where the issue ocurred.</param>
-        /// <param name="column">The column where the issue ocurred.</param>
+        /// <param name="line">The line where the issue occurred.</param>
+        /// <param name="column">The column where the issue occurred.</param>
         /// <returns>Formatted options string for the warning service message.</returns>
         private static string FormatWarningOptions(DirectoryPath rootDirectoryPath, FilePath filePath, int? line, int? column)
         {
@@ -85,7 +85,7 @@ private static string FormatWarningOptions(DirectoryPath rootDirectoryPath, File
         }
 
         /// <summary>
-        /// 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.
         /// </summary>
         /// <param name="issues">Issues which should be reported.</param>
         private void WriteGroupedIssues(IEnumerable<IIssue> issues)

src/Cake.Issues.PullRequests/IPullRequestDiscussionThread.cs

@@ -36,7 +36,7 @@ public interface IPullRequestDiscussionThread
         string CommentSource { get; set; }
 
         /// <summary>
-        /// 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.
         /// </summary>
         string ProviderType { get; set; }

src/Cake.Issues.PullRequests/ISupportCheckingCommitId.cs

@@ -1,7 +1,7 @@
 namespace Cake.Issues.PullRequests
 {
     /// <summary>
-    /// 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.
     /// </summary>
     public interface ISupportCheckingCommitId
         : IPullRequestSystemCapability

src/Cake.Issues.PullRequests/IssueFilterer.cs

@@ -201,7 +201,7 @@ private IList<IIssue> FilterPreExistingComments(
         }
 
         /// <summary>
-        /// 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.
         /// </summary>
         /// <param name="issues">List of issues which should be filtered.</param>
         /// <param name="existingThreads">List of threads which were reported by Cake.Issues.</param>

src/Cake.Issues.PullRequests/Orchestrator.cs

@@ -276,7 +276,7 @@ private Dictionary<IIssue, IssueCommentInfo> GetCommentsForIssue(
 
         /// <summary>
         /// 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 <see cref="IPullRequestDiscussionThread.CommentSource"/>.

src/Cake.Issues.Reporting.Console/ConsoleIssueReportFormatSettings.cs

@@ -12,7 +12,7 @@ public class ConsoleIssueReportFormatSettings
         public bool ShowDiagnostics { get; set; } = true;
 
         /// <summary>
-        /// 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 <c>false</c>.
         /// </summary>
         public bool Compact { get; set; }