zoriya/octokit.net
1
0
Fork 0
mirror of https://github.com/zoriya/octokit.net.git synced 2026-06-06 12:03:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Clarifies usage of reference in IReferencesClient methods (#1778)

Browse Source 
* Clairifies usage of IReferencesClient.Delete

Details the format of the reference parameter

* update xml doc in all the places
This commit is contained in:
Jordan Brown
2018-04-23 07:27:15 -04:00
committed by Ryan Gribble
parent 600c8657e4
commit e51cc451a4
4 changed files with 24 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Octokit.Reactive/Clients/IObservableReferencesClient.cs
+6 -6
View File
@@ -20,7 +20,7 @@ namespace Octokit.Reactive
/// </remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="reference">The name of the reference</param>
/// <param name="reference">The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1"</param>
/// <returns></returns>
[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
/// </remarks>
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="reference">The name of the reference</param>
/// <param name="reference">The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1"</param>
/// <returns></returns>
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get",
Justification = "Method makes a network request")]
@@ -162,7 +162,7 @@ namespace Octokit.Reactive
/// </remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="reference">The name of the reference</param>
/// <param name="reference">The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1"</param>
/// <param name="referenceUpdate">The updated reference data</param>
/// <returns></returns>
IObservable<Reference> 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
/// </remarks>
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="reference">The name of the reference</param>
/// <param name="reference">The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1"</param>
/// <param name="referenceUpdate">The updated reference data</param>
/// <returns></returns>
IObservable<Reference> Update(long repositoryId, string reference, ReferenceUpdate referenceUpdate);
@@ -187,7 +187,7 @@ namespace Octokit.Reactive
/// </remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="reference">The name of the reference</param>
/// <param name="reference">The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1"</param>
/// <returns></returns>
IObservable<Unit> Delete(string owner, string name, string reference);
@@ -198,7 +198,7 @@ namespace Octokit.Reactive
/// http://developer.github.com/v3/git/refs/#delete-a-reference
/// </remarks>
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="reference">The name of the reference</param>
/// <param name="reference">The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1"</param>
/// <returns></returns>
IObservable<Unit> Delete(long repositoryId, string reference);
}
Octokit.Reactive/Clients/ObservableReferencesClient.cs
+6 -6
View File
@@ -32,7 +32,7 @@ namespace Octokit.Reactive
/// </remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="reference">The name of the reference</param>
/// <param name="reference">The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1"</param>
/// <returns></returns>
public IObservable<Reference> Get(string owner, string name, string reference)
{
@@ -50,7 +50,7 @@ namespace Octokit.Reactive
/// http://developer.github.com/v3/git/refs/#get-a-reference
/// </remarks>
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="reference">The name of the reference</param>
/// <param name="reference">The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1"</param>
/// <returns></returns>
public IObservable<Reference> Get(long repositoryId, string reference)
{
@@ -232,7 +232,7 @@ namespace Octokit.Reactive
/// </remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="reference">The name of the reference</param>
/// <param name="reference">The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1"</param>
/// <param name="referenceUpdate">The updated reference data</param>
/// <returns></returns>
public IObservable<Reference> 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
/// </remarks>
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="reference">The name of the reference</param>
/// <param name="reference">The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1"</param>
/// <param name="referenceUpdate">The updated reference data</param>
/// <returns></returns>
public IObservable<Reference> Update(long repositoryId, string reference, ReferenceUpdate referenceUpdate)
@@ -271,7 +271,7 @@ namespace Octokit.Reactive
/// </remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="reference">The name of the reference</param>
/// <param name="reference">The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1"</param>
/// <returns></returns>
public IObservable<Unit> Delete(string owner, string name, string reference)
{
@@ -289,7 +289,7 @@ namespace Octokit.Reactive
/// http://developer.github.com/v3/git/refs/#delete-a-reference
/// </remarks>
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="reference">The name of the reference</param>
/// <param name="reference">The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1"</param>
/// <returns></returns>
public IObservable<Unit> Delete(long repositoryId, string reference)
{
Octokit/Clients/IReferencesClient.cs
+6 -6
View File
@@ -20,7 +20,7 @@ namespace Octokit
/// </remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="reference">The name of the reference</param>
/// <param name="reference">The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1"</param>
/// <returns></returns>
[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
/// </remarks>
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="reference">The name of the reference</param>
/// <param name="reference">The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1"</param>
/// <returns></returns>
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get",
Justification = "Method makes a network request")]
@@ -162,7 +162,7 @@ namespace Octokit
/// </remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="reference">The name of the reference</param>
/// <param name="reference">The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1"</param>
/// <param name="referenceUpdate">The updated reference data</param>
/// <returns></returns>
Task<Reference> 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
/// </remarks>
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="reference">The name of the reference</param>
/// <param name="reference">The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1"</param>
/// <param name="referenceUpdate">The updated reference data</param>
/// <returns></returns>
Task<Reference> Update(long repositoryId, string reference, ReferenceUpdate referenceUpdate);
@@ -187,7 +187,7 @@ namespace Octokit
/// </remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="reference">The name of the reference</param>
/// <param name="reference">The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1"</param>
/// <returns></returns>
Task Delete(string owner, string name, string reference);
@@ -198,7 +198,7 @@ namespace Octokit
/// http://developer.github.com/v3/git/refs/#delete-a-reference
/// </remarks>
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="reference">The name of the reference</param>
/// <param name="reference">The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1"</param>
/// <returns></returns>
Task Delete(long repositoryId, string reference);
}
Octokit/Clients/ReferencesClient.cs
+6 -6
View File
@@ -28,7 +28,7 @@ namespace Octokit
/// </remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="reference">The name of the reference</param>
/// <param name="reference">The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1"</param>
/// <returns></returns>
public Task<Reference> Get(string owner, string name, string reference)
{
@@ -46,7 +46,7 @@ namespace Octokit
/// http://developer.github.com/v3/git/refs/#get-a-reference
/// </remarks>
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="reference">The name of the reference</param>
/// <param name="reference">The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1"</param>
/// <returns></returns>
public Task<Reference> Get(long repositoryId, string reference)
{
@@ -232,7 +232,7 @@ namespace Octokit
/// </remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="reference">The name of the reference</param>
/// <param name="reference">The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1"</param>
/// <param name="referenceUpdate">The updated reference data</param>
/// <returns></returns>
public Task<Reference> 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
/// </remarks>
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="reference">The name of the reference</param>
/// <param name="reference">The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1"</param>
/// <param name="referenceUpdate">The updated reference data</param>
/// <returns></returns>
public Task<Reference> Update(long repositoryId, string reference, ReferenceUpdate referenceUpdate)
@@ -271,7 +271,7 @@ namespace Octokit
/// </remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="reference">The name of the reference</param>
/// <param name="reference">The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1"</param>
/// <returns></returns>
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
/// </remarks>
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="reference">The name of the reference</param>
/// <param name="reference">The canonical name of the reference without the 'refs/' prefix. e.g. "heads/master" or "tags/release-1"</param>
/// <returns></returns>
public Task Delete(long repositoryId, string reference)
{