Skip to content

Commit 4d46d5f

Browse files
authored
docs: update code docs for SetRequestTimeout (#2520)
1 parent 80b82aa commit 4d46d5f

7 files changed

Lines changed: 10 additions & 7 deletions

File tree

Octokit.Reactive/IObservableGitHubClient.cs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ public interface IObservableGitHubClient : IApiInfoProvider
77
IConnection Connection { get; }
88

99
/// <summary>
10-
/// Set the GitHub Api request timeout.
10+
/// Sets the timeout for the connection between the client and the server.
11+
/// Github will terminate the request if it takes more than 10 seconds to process the request
1112
/// Useful to set a specific timeout for lengthy operations, such as uploading release assets
1213
/// </summary>
1314
/// <remarks>

Octokit.Reactive/ObservableGitHubClient.cs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,8 @@ public IConnection Connection
5757
}
5858

5959
/// <summary>
60-
/// Set the GitHub Api request timeout.
60+
/// Sets the timeout for the connection between the client and the server.
61+
/// Github will terminate the request if it takes more than 10 seconds to process the request
6162
/// Useful to set a specific timeout for lengthy operations, such as uploading release assets
6263
/// </summary>
6364
/// <remarks>

Octokit/GitHubClient.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ public GitHubClient(IConnection connection)
114114
}
115115

116116
/// <summary>
117-
/// Set the GitHub Api request timeout.
117+
/// Sets the timeout for the connection between the client and the server.
118118
/// Useful to set a specific timeout for lengthy operations, such as uploading release assets
119119
/// </summary>
120120
/// <remarks>

Octokit/Http/Connection.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -832,7 +832,7 @@ static string GetVersionInformation()
832832
}
833833

834834
/// <summary>
835-
/// Set the GitHub Api request timeout.
835+
/// Sets the timeout for the connection between the client and the server.
836836
/// </summary>
837837
/// <param name="timeout">The Timeout value</param>
838838
public void SetRequestTimeout(TimeSpan timeout)

Octokit/Http/IConnection.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -327,7 +327,7 @@ Task<IApiResponse<T>> Post<T>(
327327
Credentials Credentials { get; set; }
328328

329329
/// <summary>
330-
/// Set the GitHub Api request timeout.
330+
/// Sets the timeout for the connection between the client and the server.
331331
/// </summary>
332332
/// <param name="timeout">The Timeout value</param>
333333
void SetRequestTimeout(TimeSpan timeout);

Octokit/Http/IHttpClient.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ public interface IHttpClient : IDisposable
2222

2323

2424
/// <summary>
25-
/// Set the GitHub API request timeout.
25+
/// Sets the timeout for the connection between the client and the server.
2626
/// </summary>
2727
/// <param name="timeout">The Timeout value</param>
2828
void SetRequestTimeout(TimeSpan timeout);

Octokit/IGitHubClient.cs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ namespace Octokit
88
public interface IGitHubClient : IApiInfoProvider
99
{
1010
/// <summary>
11-
/// Set the GitHub API request timeout.
11+
/// Sets the timeout for the connection between the client and the server.
12+
/// Github will terminate the request if it takes more than 10 seconds to process the request
1213
/// Useful to set a specific timeout for lengthy operations, such as uploading release assets
1314
/// </summary>
1415
/// <remarks>

0 commit comments

Comments
 (0)