From e51cc451a410bfada20afc8cbb52330fb38a0a3f Mon Sep 17 00:00:00 2001 From: Jordan Brown Date: Mon, 23 Apr 2018 07:27:15 -0400 Subject: [PATCH] Clarifies usage of reference in IReferencesClient methods (#1778) * Clairifies usage of IReferencesClient.Delete Details the format of the reference parameter * update xml doc in all the places --- .../Clients/IObservableReferencesClient.cs | 12 ++++++------ .../Clients/ObservableReferencesClient.cs | 12 ++++++------ Octokit/Clients/IReferencesClient.cs | 12 ++++++------ Octokit/Clients/ReferencesClient.cs | 12 ++++++------ 4 files changed, 24 insertions(+), 24 deletions(-) diff --git a/Octokit.Reactive/Clients/IObservableReferencesClient.cs b/Octokit.Reactive/Clients/IObservableReferencesClient.cs index 5a178778..323e1caa 100644 --- a/Octokit.Reactive/Clients/IObservableReferencesClient.cs +++ b/Octokit.Reactive/Clients/IObservableReferencesClient.cs @@ -20,7 +20,7 @@ namespace Octokit.Reactive /// /// The owner of the repository /// The name of the repository - /// The name of the reference + /// The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1" /// [SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get", Justification = "Method makes a network request")] @@ -33,7 +33,7 @@ namespace Octokit.Reactive /// http://developer.github.com/v3/git/refs/#get-a-reference /// /// The Id of the repository - /// The name of the reference + /// The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1" /// [SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get", Justification = "Method makes a network request")] @@ -162,7 +162,7 @@ namespace Octokit.Reactive /// /// The owner of the repository /// The name of the repository - /// The name of the reference + /// The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1" /// The updated reference data /// IObservable Update(string owner, string name, string reference, ReferenceUpdate referenceUpdate); @@ -174,7 +174,7 @@ namespace Octokit.Reactive /// http://developer.github.com/v3/git/refs/#update-a-reference /// /// The Id of the repository - /// The name of the reference + /// The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1" /// The updated reference data /// IObservable Update(long repositoryId, string reference, ReferenceUpdate referenceUpdate); @@ -187,7 +187,7 @@ namespace Octokit.Reactive /// /// The owner of the repository /// The name of the repository - /// The name of the reference + /// The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1" /// IObservable Delete(string owner, string name, string reference); @@ -198,7 +198,7 @@ namespace Octokit.Reactive /// http://developer.github.com/v3/git/refs/#delete-a-reference /// /// The Id of the repository - /// The name of the reference + /// The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1" /// IObservable Delete(long repositoryId, string reference); } diff --git a/Octokit.Reactive/Clients/ObservableReferencesClient.cs b/Octokit.Reactive/Clients/ObservableReferencesClient.cs index 4cf3df81..b5353bd2 100644 --- a/Octokit.Reactive/Clients/ObservableReferencesClient.cs +++ b/Octokit.Reactive/Clients/ObservableReferencesClient.cs @@ -32,7 +32,7 @@ namespace Octokit.Reactive /// /// The owner of the repository /// The name of the repository - /// The name of the reference + /// The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1" /// public IObservable Get(string owner, string name, string reference) { @@ -50,7 +50,7 @@ namespace Octokit.Reactive /// http://developer.github.com/v3/git/refs/#get-a-reference /// /// The Id of the repository - /// The name of the reference + /// The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1" /// public IObservable Get(long repositoryId, string reference) { @@ -232,7 +232,7 @@ namespace Octokit.Reactive /// /// The owner of the repository /// The name of the repository - /// The name of the reference + /// The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1" /// The updated reference data /// public IObservable Update(string owner, string name, string reference, ReferenceUpdate referenceUpdate) @@ -252,7 +252,7 @@ namespace Octokit.Reactive /// http://developer.github.com/v3/git/refs/#update-a-reference /// /// The Id of the repository - /// The name of the reference + /// The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1" /// The updated reference data /// public IObservable Update(long repositoryId, string reference, ReferenceUpdate referenceUpdate) @@ -271,7 +271,7 @@ namespace Octokit.Reactive /// /// The owner of the repository /// The name of the repository - /// The name of the reference + /// The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1" /// public IObservable Delete(string owner, string name, string reference) { @@ -289,7 +289,7 @@ namespace Octokit.Reactive /// http://developer.github.com/v3/git/refs/#delete-a-reference /// /// The Id of the repository - /// The name of the reference + /// The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1" /// public IObservable Delete(long repositoryId, string reference) { diff --git a/Octokit/Clients/IReferencesClient.cs b/Octokit/Clients/IReferencesClient.cs index 93497b19..04122e2f 100644 --- a/Octokit/Clients/IReferencesClient.cs +++ b/Octokit/Clients/IReferencesClient.cs @@ -20,7 +20,7 @@ namespace Octokit /// /// The owner of the repository /// The name of the repository - /// The name of the reference + /// The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1" /// [SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get", Justification = "Method makes a network request")] @@ -33,7 +33,7 @@ namespace Octokit /// http://developer.github.com/v3/git/refs/#get-a-reference /// /// The Id of the repository - /// The name of the reference + /// The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1" /// [SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get", Justification = "Method makes a network request")] @@ -162,7 +162,7 @@ namespace Octokit /// /// The owner of the repository /// The name of the repository - /// The name of the reference + /// The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1" /// The updated reference data /// Task Update(string owner, string name, string reference, ReferenceUpdate referenceUpdate); @@ -174,7 +174,7 @@ namespace Octokit /// http://developer.github.com/v3/git/refs/#update-a-reference /// /// The Id of the repository - /// The name of the reference + /// The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1" /// The updated reference data /// Task Update(long repositoryId, string reference, ReferenceUpdate referenceUpdate); @@ -187,7 +187,7 @@ namespace Octokit /// /// The owner of the repository /// The name of the repository - /// The name of the reference + /// The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1" /// Task Delete(string owner, string name, string reference); @@ -198,7 +198,7 @@ namespace Octokit /// http://developer.github.com/v3/git/refs/#delete-a-reference /// /// The Id of the repository - /// The name of the reference + /// The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1" /// Task Delete(long repositoryId, string reference); } diff --git a/Octokit/Clients/ReferencesClient.cs b/Octokit/Clients/ReferencesClient.cs index 403fa581..1b5fdb3f 100644 --- a/Octokit/Clients/ReferencesClient.cs +++ b/Octokit/Clients/ReferencesClient.cs @@ -28,7 +28,7 @@ namespace Octokit /// /// The owner of the repository /// The name of the repository - /// The name of the reference + /// The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1" /// public Task Get(string owner, string name, string reference) { @@ -46,7 +46,7 @@ namespace Octokit /// http://developer.github.com/v3/git/refs/#get-a-reference /// /// The Id of the repository - /// The name of the reference + /// The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1" /// public Task Get(long repositoryId, string reference) { @@ -232,7 +232,7 @@ namespace Octokit /// /// The owner of the repository /// The name of the repository - /// The name of the reference + /// The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1" /// The updated reference data /// public Task Update(string owner, string name, string reference, ReferenceUpdate referenceUpdate) @@ -252,7 +252,7 @@ namespace Octokit /// http://developer.github.com/v3/git/refs/#update-a-reference /// /// The Id of the repository - /// The name of the reference + /// The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1" /// The updated reference data /// public Task Update(long repositoryId, string reference, ReferenceUpdate referenceUpdate) @@ -271,7 +271,7 @@ namespace Octokit /// /// The owner of the repository /// The name of the repository - /// The name of the reference + /// The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1" /// public Task Delete(string owner, string name, string reference) { @@ -289,7 +289,7 @@ namespace Octokit /// http://developer.github.com/v3/git/refs/#delete-a-reference /// /// The Id of the repository - /// The name of the reference + /// The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1" /// public Task Delete(long repositoryId, string reference) {