zoriya/octokit.net
1
0
Fork 0
mirror of https://github.com/zoriya/octokit.net.git synced 2025-12-20 22:25:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

Generate documentation comments for the

Browse Source 
`Reactive` project
This commit is contained in:
Peter MacNaughton
2014-02-26 22:09:23 -07:00
parent 64bd9d4b9b
commit 04d6e9b386
15 changed files with 140 additions and 69 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
Octokit.Reactive/Clients/ObservableStatisticsClient.cs
View File

@@ -15,6 +15,12 @@ namespace Octokit.Reactive
_client = client;
}
/// <summary>
/// Returns a list of <see cref="Contributor"/> for the given repository
/// </summary>
/// <param name="owner">The owner of the repository</param>
/// <param name="repositoryName">The name of the repository</param>
/// <returns>A list of <see cref="Contributor"/></returns>
public IObservable<IEnumerable<Contributor>> GetContributors(string owner, string repositoryName)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -23,6 +29,12 @@ namespace Octokit.Reactive
return _client.Repository.Statistics.GetContributors(owner, repositoryName).ToObservable();
}
/// <summary>
/// Returns the last year of commit activity grouped by week.
/// </summary>
/// <param name="owner">The owner of the repository</param>
/// <param name="repositoryName">The name of the repository</param>
/// <returns>The last year of <see cref="CommitActivity"/></returns>
public IObservable<CommitActivity> GetCommitActivity(string owner, string repositoryName)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -31,6 +43,12 @@ namespace Octokit.Reactive
return _client.Repository.Statistics.GetCommitActivity(owner, repositoryName).ToObservable();
}
/// <summary>
/// Returns a weekly aggregate of the number of additions and deletions pushed to a repository.
/// </summary>
/// <param name="owner">The owner of the repository</param>
/// <param name="repositoryName">The name of the repository</param>
/// <returns>Returns a weekly aggregate of the number additions and deletion</returns>
public IObservable<CodeFrequency> GetCodeFrequency(string owner, string repositoryName)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -39,6 +57,12 @@ namespace Octokit.Reactive
return _client.Repository.Statistics.GetCodeFrequency(owner, repositoryName).ToObservable();
}
/// <summary>
/// Returns the total commit counts for the owner and total commit counts in total.
/// </summary>
/// <param name="owner">The owner of the repository</param>
/// <param name="repositoryName">The name of the repository</param>
/// <returns>Returns <see cref="Participation"/>from oldest week to now</returns>
public IObservable<Participation> GetParticipation(string owner, string repositoryName)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -47,6 +71,12 @@ namespace Octokit.Reactive
return _client.Repository.Statistics.GetParticipation(owner, repositoryName).ToObservable();
}
/// <summary>
/// Returns a list of the number of commits per hour in each day
/// </summary>
/// <param name="owner">The owner of the repository</param>
/// <param name="repositoryName">The name of the repository</param>
/// <returns>Returns commit counts per hour in each day</returns>
public IObservable<PunchCard> GetPunchCard(string owner, string repositoryName)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");