mirror of
https://github.com/zoriya/octokit.net.git
synced 2026-06-04 11:24:44 +00:00
docs: update code docs for SetRequestTimeout (#2520)
This commit is contained in:
@@ -7,7 +7,8 @@ namespace Octokit.Reactive
|
||||
IConnection Connection { get; }
|
||||
|
||||
/// <summary>
|
||||
/// 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
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
|
||||
@@ -57,7 +57,8 @@ namespace Octokit.Reactive
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 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
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
|
||||
@@ -114,7 +114,7 @@ namespace Octokit
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// 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
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
|
||||
@@ -832,7 +832,7 @@ namespace Octokit
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Set the GitHub Api request timeout.
|
||||
/// Sets the timeout for the connection between the client and the server.
|
||||
/// </summary>
|
||||
/// <param name="timeout">The Timeout value</param>
|
||||
public void SetRequestTimeout(TimeSpan timeout)
|
||||
|
||||
@@ -327,7 +327,7 @@ namespace Octokit
|
||||
Credentials Credentials { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Set the GitHub Api request timeout.
|
||||
/// Sets the timeout for the connection between the client and the server.
|
||||
/// </summary>
|
||||
/// <param name="timeout">The Timeout value</param>
|
||||
void SetRequestTimeout(TimeSpan timeout);
|
||||
|
||||
@@ -22,7 +22,7 @@ namespace Octokit.Internal
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// Set the GitHub API request timeout.
|
||||
/// Sets the timeout for the connection between the client and the server.
|
||||
/// </summary>
|
||||
/// <param name="timeout">The Timeout value</param>
|
||||
void SetRequestTimeout(TimeSpan timeout);
|
||||
|
||||
@@ -8,7 +8,8 @@ namespace Octokit
|
||||
public interface IGitHubClient : IApiInfoProvider
|
||||
{
|
||||
/// <summary>
|
||||
/// 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
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
|
||||
Reference in New Issue
Block a user