diff --git a/Octokit.Reactive/Clients/IObservableCommitsClient.cs b/Octokit.Reactive/Clients/IObservableCommitsClient.cs
index a33beb1c..b559dd65 100644
--- a/Octokit.Reactive/Clients/IObservableCommitsClient.cs
+++ b/Octokit.Reactive/Clients/IObservableCommitsClient.cs
@@ -3,6 +3,12 @@ using System.Diagnostics.CodeAnalysis;
namespace Octokit.Reactive
{
+ ///
+ /// A client for GitHub's Git Commits API.
+ ///
+ ///
+ /// See the Git Commits API documentation for more information.
+ ///
public interface IObservableCommitsClient
{
///
@@ -14,7 +20,7 @@ namespace Octokit.Reactive
/// The owner of the repository
/// The name of the repository
/// Tha sha reference of the commit
- ///
+ /// A representing commit for specified repository and reference
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get",
Justification = "Method makes a network request")]
IObservable Get(string owner, string name, string reference);
@@ -28,7 +34,7 @@ namespace Octokit.Reactive
/// The owner of the repository
/// The name of the repository
/// The commit to create
- ///
+ /// A of representing created commit for specified repository
IObservable Create(string owner, string name, NewCommit commit);
}
}
\ No newline at end of file
diff --git a/Octokit.Reactive/Clients/ObservableCommitsClient.cs b/Octokit.Reactive/Clients/ObservableCommitsClient.cs
index 3eccadc5..7ff8af2c 100644
--- a/Octokit.Reactive/Clients/ObservableCommitsClient.cs
+++ b/Octokit.Reactive/Clients/ObservableCommitsClient.cs
@@ -3,6 +3,12 @@ using System.Reactive.Threading.Tasks;
namespace Octokit.Reactive
{
+ ///
+ /// A client for GitHub's Git Commits API.
+ ///
+ ///
+ /// See the Git Commits API documentation for more information.
+ ///
public class ObservableCommitsClient : IObservableCommitsClient
{
readonly ICommitsClient _client;
@@ -10,6 +16,7 @@ namespace Octokit.Reactive
public ObservableCommitsClient(IGitHubClient client)
{
Ensure.ArgumentNotNull(client, "client");
+
_client = client.Git.Commit;
}
@@ -22,7 +29,7 @@ namespace Octokit.Reactive
/// The owner of the repository
/// The name of the repository
/// Tha sha reference of the commit
- ///
+ /// A representing commit for specified repository and reference
public IObservable Get(string owner, string name, string reference)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -41,7 +48,7 @@ namespace Octokit.Reactive
/// The owner of the repository
/// The name of the repository
/// The commit to create
- ///
+ /// A of representing created commit for specified repository
public IObservable Create(string owner, string name, NewCommit commit)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
diff --git a/Octokit/Clients/CommitsClient.cs b/Octokit/Clients/CommitsClient.cs
index 555b6617..c366d2a5 100644
--- a/Octokit/Clients/CommitsClient.cs
+++ b/Octokit/Clients/CommitsClient.cs
@@ -28,7 +28,7 @@ namespace Octokit
/// The owner of the repository
/// The name of the repository
/// Tha sha reference of the commit
- ///
+ /// A representing commit for specified repository and reference
public Task Get(string owner, string name, string reference)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -47,7 +47,7 @@ namespace Octokit
/// The owner of the repository
/// The name of the repository
/// The commit to create
- ///
+ /// A representing created commit for specified repository
public Task Create(string owner, string name, NewCommit commit)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
diff --git a/Octokit/Clients/ICommitsClient.cs b/Octokit/Clients/ICommitsClient.cs
index b4227d02..6bde299a 100644
--- a/Octokit/Clients/ICommitsClient.cs
+++ b/Octokit/Clients/ICommitsClient.cs
@@ -20,7 +20,7 @@ namespace Octokit
/// The owner of the repository
/// The name of the repository
/// Tha sha reference of the commit
- ///
+ /// A representing commit for specified repository and reference
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get",
Justification = "Method makes a network request")]
Task Get(string owner, string name, string reference);
@@ -34,7 +34,7 @@ namespace Octokit
/// The owner of the repository
/// The name of the repository
/// The commit to create
- ///
+ /// A representing created commit for specified repository
Task Create(string owner, string name, NewCommit commit);
}
}
\ No newline at end of file