From fe36783c6a08e02dd2d173ec62c7641816fb681c Mon Sep 17 00:00:00 2001 From: Brendan Forster Date: Mon, 1 Jun 2015 08:13:58 +0930 Subject: [PATCH] and the other docs --- .../Clients/IObservableRepositoryContentsClient.cs | 4 +++- .../Clients/ObservableRepositoryContentsClient.cs | 4 +++- Octokit/Clients/RepositoryContentsClient.cs | 6 +++--- 3 files changed, 9 insertions(+), 5 deletions(-) diff --git a/Octokit.Reactive/Clients/IObservableRepositoryContentsClient.cs b/Octokit.Reactive/Clients/IObservableRepositoryContentsClient.cs index ed132889..a5221a6b 100644 --- a/Octokit.Reactive/Clients/IObservableRepositoryContentsClient.cs +++ b/Octokit.Reactive/Clients/IObservableRepositoryContentsClient.cs @@ -43,6 +43,7 @@ namespace Octokit.Reactive /// https://developer.github.com/v3/repos/contents/#get-archive-link /// The owner of the repository /// The name of the repository + /// A promise, containing the binary contents of the archive IObservable GetArchive(string owner, string name); /// @@ -66,7 +67,7 @@ namespace Octokit.Reactive /// The owner of the repository /// The name of the repository /// The format of the archive. Can be either tarball or zipball - /// + /// A promise, containing the binary contents of the archive IObservable GetArchive(string owner, string name, ArchiveFormat archiveFormat); /// @@ -92,6 +93,7 @@ namespace Octokit.Reactive /// The name of the repository /// The format of the archive. Can be either tarball or zipball /// A valid Git reference. + /// A promise, containing the binary contents of the archive IObservable GetArchive(string owner, string name, ArchiveFormat archiveFormat, string reference); /// diff --git a/Octokit.Reactive/Clients/ObservableRepositoryContentsClient.cs b/Octokit.Reactive/Clients/ObservableRepositoryContentsClient.cs index 8c7dde33..a4a5e4b2 100644 --- a/Octokit.Reactive/Clients/ObservableRepositoryContentsClient.cs +++ b/Octokit.Reactive/Clients/ObservableRepositoryContentsClient.cs @@ -71,6 +71,7 @@ namespace Octokit.Reactive /// https://developer.github.com/v3/repos/contents/#get-archive-link /// The owner of the repository /// The name of the repository + /// A promise, containing the binary contents of the archive public IObservable GetArchive(string owner, string name) { return _client.Repository.Content.GetArchive(owner, name).ToObservable(); @@ -100,7 +101,7 @@ namespace Octokit.Reactive /// The owner of the repository /// The name of the repository /// The format of the archive. Can be either tarball or zipball - /// + /// A promise, containing the binary contents of the archive public IObservable GetArchive(string owner, string name, ArchiveFormat archiveFormat) { return _client.Repository.Content.GetArchive(owner, name, archiveFormat).ToObservable(); @@ -135,6 +136,7 @@ namespace Octokit.Reactive /// The name of the repository /// The format of the archive. Can be either tarball or zipball /// A valid Git reference. + /// A promise, containing the binary contents of the archive public IObservable GetArchive(string owner, string name, ArchiveFormat archiveFormat, string reference) { return _client.Repository.Content.GetArchive(owner, name, archiveFormat, reference).ToObservable(); diff --git a/Octokit/Clients/RepositoryContentsClient.cs b/Octokit/Clients/RepositoryContentsClient.cs index ae252ebb..5f866caf 100644 --- a/Octokit/Clients/RepositoryContentsClient.cs +++ b/Octokit/Clients/RepositoryContentsClient.cs @@ -95,7 +95,7 @@ namespace Octokit /// https://developer.github.com/v3/repos/contents/#get-archive-link /// The owner of the repository /// The name of the repository - /// + /// The binary contents of the archive public Task GetArchive(string owner, string name) { return GetArchive(owner, name, ArchiveFormat.Tarball, string.Empty); @@ -124,7 +124,7 @@ namespace Octokit /// The owner of the repository /// The name of the repository /// The format of the archive. Can be either tarball or zipball - /// + /// The binary contents of the archive public Task GetArchive(string owner, string name, ArchiveFormat archiveFormat) { return GetArchive(owner, name, archiveFormat, string.Empty); @@ -158,7 +158,7 @@ namespace Octokit /// The name of the repository /// The format of the archive. Can be either tarball or zipball /// A valid Git reference. - /// + /// The binary contents of the archive public async Task GetArchive(string owner, string name, ArchiveFormat archiveFormat, string reference) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner");