From 145c11dbc51153fd30a0ab45dd3fb9e198d53a4f Mon Sep 17 00:00:00 2001 From: notauserx Date: Wed, 3 Aug 2022 12:55:41 +0600 Subject: [PATCH] update code docs for SetRequestTimeout --- Octokit.Reactive/IObservableGitHubClient.cs | 3 ++- Octokit.Reactive/ObservableGitHubClient.cs | 3 ++- Octokit/GitHubClient.cs | 2 +- Octokit/Http/Connection.cs | 2 +- Octokit/Http/IConnection.cs | 2 +- Octokit/Http/IHttpClient.cs | 2 +- Octokit/IGitHubClient.cs | 3 ++- 7 files changed, 10 insertions(+), 7 deletions(-) diff --git a/Octokit.Reactive/IObservableGitHubClient.cs b/Octokit.Reactive/IObservableGitHubClient.cs index bacdc13d72..e4f91ec061 100644 --- a/Octokit.Reactive/IObservableGitHubClient.cs +++ b/Octokit.Reactive/IObservableGitHubClient.cs @@ -7,7 +7,8 @@ public interface IObservableGitHubClient : IApiInfoProvider IConnection Connection { get; } /// - /// Set the GitHub Api request timeout. + /// Sets the timeout for the connection between the client and the server. + /// Github will terminate the request if it takes more than 10 seconds to process the request /// Useful to set a specific timeout for lengthy operations, such as uploading release assets /// /// diff --git a/Octokit.Reactive/ObservableGitHubClient.cs b/Octokit.Reactive/ObservableGitHubClient.cs index f891ec847d..a063faae62 100644 --- a/Octokit.Reactive/ObservableGitHubClient.cs +++ b/Octokit.Reactive/ObservableGitHubClient.cs @@ -57,7 +57,8 @@ public IConnection Connection } /// - /// Set the GitHub Api request timeout. + /// Sets the timeout for the connection between the client and the server. + /// Github will terminate the request if it takes more than 10 seconds to process the request /// Useful to set a specific timeout for lengthy operations, such as uploading release assets /// /// diff --git a/Octokit/GitHubClient.cs b/Octokit/GitHubClient.cs index df766a1ed9..f030540853 100644 --- a/Octokit/GitHubClient.cs +++ b/Octokit/GitHubClient.cs @@ -114,7 +114,7 @@ public GitHubClient(IConnection connection) } /// - /// Set the GitHub Api request timeout. + /// Sets the timeout for the connection between the client and the server. /// Useful to set a specific timeout for lengthy operations, such as uploading release assets /// /// diff --git a/Octokit/Http/Connection.cs b/Octokit/Http/Connection.cs index 9c247c502c..17cfce19fb 100644 --- a/Octokit/Http/Connection.cs +++ b/Octokit/Http/Connection.cs @@ -832,7 +832,7 @@ static string GetVersionInformation() } /// - /// Set the GitHub Api request timeout. + /// Sets the timeout for the connection between the client and the server. /// /// The Timeout value public void SetRequestTimeout(TimeSpan timeout) diff --git a/Octokit/Http/IConnection.cs b/Octokit/Http/IConnection.cs index f53f361be9..ff4b6359f1 100644 --- a/Octokit/Http/IConnection.cs +++ b/Octokit/Http/IConnection.cs @@ -327,7 +327,7 @@ Task> Post( Credentials Credentials { get; set; } /// - /// Set the GitHub Api request timeout. + /// Sets the timeout for the connection between the client and the server. /// /// The Timeout value void SetRequestTimeout(TimeSpan timeout); diff --git a/Octokit/Http/IHttpClient.cs b/Octokit/Http/IHttpClient.cs index bda7a0409f..95e0d5055d 100644 --- a/Octokit/Http/IHttpClient.cs +++ b/Octokit/Http/IHttpClient.cs @@ -22,7 +22,7 @@ public interface IHttpClient : IDisposable /// - /// Set the GitHub API request timeout. + /// Sets the timeout for the connection between the client and the server. /// /// The Timeout value void SetRequestTimeout(TimeSpan timeout); diff --git a/Octokit/IGitHubClient.cs b/Octokit/IGitHubClient.cs index d6aa599f8a..43b0179335 100644 --- a/Octokit/IGitHubClient.cs +++ b/Octokit/IGitHubClient.cs @@ -8,7 +8,8 @@ namespace Octokit public interface IGitHubClient : IApiInfoProvider { /// - /// Set the GitHub API request timeout. + /// Sets the timeout for the connection between the client and the server. + /// Github will terminate the request if it takes more than 10 seconds to process the request /// Useful to set a specific timeout for lengthy operations, such as uploading release assets /// ///