tweak XmlDoc to match github documentation

octokit · Jul 14, 2018 · 7989cca · 7989cca
1 parent 7a59df5
commit 7989cca
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 20 deletions.
diff --git a/Octokit.Reactive/Clients/IObservableCheckRunsClient.cs b/Octokit.Reactive/Clients/IObservableCheckRunsClient.cs
@@ -11,7 +11,7 @@ namespace Octokit.Reactive
     public interface IObservableCheckRunsClient
     {
         /// <summary>
-        /// Creates a new Check Run
+        /// Creates a new check run for a specific commit in a repository.
         /// </summary>
         /// <remarks>
         /// See the <a href="https://developer.github.com/v3/checks/runs/#create-a-check-run">Check Runs API documentation</a> for more information.
@@ -22,7 +22,7 @@ public interface IObservableCheckRunsClient
         IObservable<CheckRun> Create(string owner, string name, NewCheckRun newCheckRun);
 
         /// <summary>
-        /// Creates a new Check Run
+        /// Creates a new check run for a specific commit in a repository.
         /// </summary>
         /// <remarks>
         /// See the <a href="https://developer.github.com/v3/checks/runs/#create-a-check-run">Check Runs API documentation</a> for more information.
@@ -32,7 +32,7 @@ public interface IObservableCheckRunsClient
         IObservable<CheckRun> Create(long repositoryId, NewCheckRun newCheckRun);
 
         /// <summary>
-        /// Updates a Check Run
+        /// Updates a check run for a specific commit in a repository.
         /// </summary>
         /// <remarks>
         /// See the <a href="https://developer.github.com/v3/checks/runs/#update-a-check-run">Check Runs API documentation</a> for more information.
@@ -44,7 +44,7 @@ public interface IObservableCheckRunsClient
         IObservable<CheckRun> Update(string owner, string name, long checkRunId, CheckRunUpdate checkRunUpdate);
 
         /// <summary>
-        /// Updates a Check Run
+        /// Updates a check run for a specific commit in a repository.
         /// </summary>
         /// <remarks>
         /// See the <a href="https://developer.github.com/v3/checks/runs/#update-a-check-run">Check Runs API documentation</a> for more information.

diff --git a/Octokit.Reactive/Clients/ObservableCheckRunsClient.cs b/Octokit.Reactive/Clients/ObservableCheckRunsClient.cs
@@ -28,7 +28,7 @@ public ObservableCheckRunsClient(IGitHubClient client)
         }
 
         /// <summary>
-        /// Creates a new Check Run
+        /// Creates a new check run for a specific commit in a repository.
         /// </summary>
         /// <remarks>
         /// See the <a href="https://developer.github.com/v3/checks/runs/#create-a-check-run">Check Runs API documentation</a> for more information.
@@ -46,7 +46,7 @@ public IObservable<CheckRun> Create(string owner, string name, NewCheckRun newCh
         }
 
         /// <summary>
-        /// Creates a new Check Run
+        /// Creates a new check run for a specific commit in a repository.
         /// </summary>
         /// <remarks>
         /// See the <a href="https://developer.github.com/v3/checks/runs/#create-a-check-run">Check Runs API documentation</a> for more information.
@@ -61,7 +61,7 @@ public IObservable<CheckRun> Create(long repositoryId, NewCheckRun newCheckRun)
         }
 
         /// <summary>
-        /// Updates a Check Run
+        /// Updates a check run for a specific commit in a repository.
         /// </summary>
         /// <remarks>
         /// See the <a href="https://developer.github.com/v3/checks/runs/#update-a-check-run">Check Runs API documentation</a> for more information.
@@ -80,7 +80,7 @@ public IObservable<CheckRun> Update(string owner, string name, long checkRunId,
         }
 
         /// <summary>
-        /// Updates a Check Run
+        /// Updates a check run for a specific commit in a repository.
         /// </summary>
         /// <remarks>
         /// See the <a href="https://developer.github.com/v3/checks/runs/#update-a-check-run">Check Runs API documentation</a> for more information.

diff --git a/Octokit.Tests.Integration/Clients/CheckRunsClientTests.cs b/Octokit.Tests.Integration/Clients/CheckRunsClientTests.cs
@@ -259,7 +259,7 @@ public async Task GetsAllCheckRuns()
                         CheckName = "name",
                         Status = CheckStatusFilter.InProgress
                     };
-                    
+
                     var checkRuns = await _githubAppInstallation.Check.Run.GetAllForCheckSuite(repoContext.RepositoryOwner, repoContext.RepositoryName, created.CheckSuite.Id, request);
 
                     // Check result

diff --git a/Octokit/Clients/CheckRunsClient.cs b/Octokit/Clients/CheckRunsClient.cs
@@ -1,5 +1,4 @@
 using System;
-using System.Collections.Generic;
 using System.Linq;
 using System.Threading.Tasks;
 
@@ -22,7 +21,7 @@ public CheckRunsClient(IApiConnection apiConnection) : base(apiConnection)
         }
 
         /// <summary>
-        /// Creates a new Check Run
+        /// Creates a new check run for a specific commit in a repository.
         /// </summary>
         /// <remarks>
         /// See the <a href="https://developer.github.com/v3/checks/runs/#create-a-check-run">Check Runs API documentation</a> for more information.
@@ -40,7 +39,7 @@ public Task<CheckRun> Create(string owner, string name, NewCheckRun newCheckRun)
         }
 
         /// <summary>
-        /// Creates a new Check Run
+        /// Creates a new check run for a specific commit in a repository.
         /// </summary>
         /// <remarks>
         /// See the <a href="https://developer.github.com/v3/checks/runs/#create-a-check-run">Check Runs API documentation</a> for more information.
@@ -55,7 +54,7 @@ public Task<CheckRun> Create(long repositoryId, NewCheckRun newCheckRun)
         }
 
         /// <summary>
-        /// Updates a Check Run
+        /// Updates a check run for a specific commit in a repository.
         /// </summary>
         /// <remarks>
         /// See the <a href="https://developer.github.com/v3/checks/runs/#update-a-check-run">Check Runs API documentation</a> for more information.
@@ -74,7 +73,7 @@ public Task<CheckRun> Update(string owner, string name, long checkRunId, CheckRu
         }
 
         /// <summary>
-        /// Updates a Check Run
+        /// Updates a check run for a specific commit in a repository.
         /// </summary>
         /// <remarks>
         /// See the <a href="https://developer.github.com/v3/checks/runs/#update-a-check-run">Check Runs API documentation</a> for more information.

diff --git a/Octokit/Clients/ICheckRunsClient.cs b/Octokit/Clients/ICheckRunsClient.cs
@@ -1,5 +1,4 @@
-using System.Collections.Generic;
-using System.Threading.Tasks;
+using System.Threading.Tasks;
 
 namespace Octokit
 {
@@ -12,7 +11,7 @@ namespace Octokit
     public interface ICheckRunsClient
     {
         /// <summary>
-        /// Creates a new Check Run
+        /// Creates a new check run for a specific commit in a repository.
         /// </summary>
         /// <remarks>
         /// See the <a href="https://developer.github.com/v3/checks/runs/#create-a-check-run">Check Runs API documentation</a> for more information.
@@ -23,7 +22,7 @@ public interface ICheckRunsClient
         Task<CheckRun> Create(string owner, string name, NewCheckRun newCheckRun);
 
         /// <summary>
-        /// Creates a new Check Run
+        /// Creates a new check run for a specific commit in a repository.
         /// </summary>
         /// <remarks>
         /// See the <a href="https://developer.github.com/v3/checks/runs/#create-a-check-run">Check Runs API documentation</a> for more information.
@@ -33,7 +32,7 @@ public interface ICheckRunsClient
         Task<CheckRun> Create(long repositoryId, NewCheckRun newCheckRun);
 
         /// <summary>
-        /// Updates a Check Run
+        /// Updates a check run for a specific commit in a repository.
         /// </summary>
         /// <remarks>
         /// See the <a href="https://developer.github.com/v3/checks/runs/#update-a-check-run">Check Runs API documentation</a> for more information.
@@ -45,7 +44,7 @@ public interface ICheckRunsClient
         Task<CheckRun> Update(string owner, string name, long checkRunId, CheckRunUpdate checkRunUpdate);
 
         /// <summary>
-        /// Updates a Check Run
+        /// Updates a check run for a specific commit in a repository.
         /// </summary>
         /// <remarks>
         /// See the <a href="https://developer.github.com/v3/checks/runs/#update-a-check-run">Check Runs API documentation</a> for more information.