diff --git a/Octokit.Reactive/IObservableGitHubClient.cs b/Octokit.Reactive/IObservableGitHubClient.cs index bacdc13d..e4f91ec0 100644 --- a/Octokit.Reactive/IObservableGitHubClient.cs +++ b/Octokit.Reactive/IObservableGitHubClient.cs @@ -7,7 +7,8 @@ namespace Octokit.Reactive 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 f891ec84..a063faae 100644 --- a/Octokit.Reactive/ObservableGitHubClient.cs +++ b/Octokit.Reactive/ObservableGitHubClient.cs @@ -57,7 +57,8 @@ namespace Octokit.Reactive } /// - /// 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 df766a1e..f0305408 100644 --- a/Octokit/GitHubClient.cs +++ b/Octokit/GitHubClient.cs @@ -114,7 +114,7 @@ namespace Octokit } /// - /// 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 9c247c50..17cfce19 100644 --- a/Octokit/Http/Connection.cs +++ b/Octokit/Http/Connection.cs @@ -832,7 +832,7 @@ namespace Octokit } /// - /// 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 f53f361b..ff4b6359 100644 --- a/Octokit/Http/IConnection.cs +++ b/Octokit/Http/IConnection.cs @@ -327,7 +327,7 @@ namespace Octokit 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 bda7a040..95e0d505 100644 --- a/Octokit/Http/IHttpClient.cs +++ b/Octokit/Http/IHttpClient.cs @@ -22,7 +22,7 @@ namespace Octokit.Internal /// - /// 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 d6aa599f..43b01793 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 /// ///