diff --git a/Octokit.Reactive/Clients/IObservableReferencesClient.cs b/Octokit.Reactive/Clients/IObservableReferencesClient.cs
index 5a17877816..323e1caa1e 100644
--- a/Octokit.Reactive/Clients/IObservableReferencesClient.cs
+++ b/Octokit.Reactive/Clients/IObservableReferencesClient.cs
@@ -20,7 +20,7 @@ public interface IObservableReferencesClient
///
/// 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 @@ public interface IObservableReferencesClient
/// 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 @@ public interface IObservableReferencesClient
///
/// 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 @@ public interface IObservableReferencesClient
/// 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 @@ public interface IObservableReferencesClient
///
/// 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 @@ public interface IObservableReferencesClient
/// 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 bb16a5d3ca..ba9b565753 100644
--- a/Octokit.Reactive/Clients/ObservableReferencesClient.cs
+++ b/Octokit.Reactive/Clients/ObservableReferencesClient.cs
@@ -32,7 +32,7 @@ public ObservableReferencesClient(IGitHubClient client)
///
/// 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 @@ public IObservable Get(string owner, string name, string reference)
/// 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 @@ public IObservable Create(long repositoryId, NewReference reference)
///
/// 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 @@ public IObservable Update(string owner, string name, string reference
/// 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 @@ public IObservable Update(long repositoryId, string reference, Refere
///
/// 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 @@ public IObservable Delete(string owner, string name, string reference)
/// 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 93497b1973..04122e2f14 100644
--- a/Octokit/Clients/IReferencesClient.cs
+++ b/Octokit/Clients/IReferencesClient.cs
@@ -20,7 +20,7 @@ public interface IReferencesClient
///
/// 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 @@ public interface IReferencesClient
/// 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 @@ public interface IReferencesClient
///
/// 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 @@ public interface IReferencesClient
/// 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 @@ public interface IReferencesClient
///
/// 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 @@ public interface IReferencesClient
/// 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 b26df045f5..58bfe6fad6 100644
--- a/Octokit/Clients/ReferencesClient.cs
+++ b/Octokit/Clients/ReferencesClient.cs
@@ -28,7 +28,7 @@ public ReferencesClient(IApiConnection apiConnection) :
///
/// 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 @@ public Task Get(string owner, string name, string reference)
/// 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 @@ public Task Create(long repositoryId, NewReference reference)
///
/// 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 @@ public Task Update(string owner, string name, string reference, Refer
/// 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 @@ public Task Update(long repositoryId, string reference, ReferenceUpda
///
/// 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 @@ public Task Delete(string owner, string name, string reference)
/// 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)
{