Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[WIP] update code docs for SetRequestTimeout #2520

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion Octokit.Reactive/IObservableGitHubClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ public interface IObservableGitHubClient : IApiInfoProvider
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>
Expand Down
3 changes: 2 additions & 1 deletion Octokit.Reactive/ObservableGitHubClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,8 @@ public IConnection Connection
}

/// <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>
Expand Down
2 changes: 1 addition & 1 deletion Octokit/GitHubClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ public GitHubClient(IConnection connection)
}

/// <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>
Expand Down
2 changes: 1 addition & 1 deletion Octokit/Http/Connection.cs
Original file line number Diff line number Diff line change
Expand Up @@ -832,7 +832,7 @@ static string GetVersionInformation()
}

/// <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)
Expand Down
2 changes: 1 addition & 1 deletion Octokit/Http/IConnection.cs
Original file line number Diff line number Diff line change
Expand Up @@ -327,7 +327,7 @@ Task<IApiResponse<T>> Post<T>(
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);
Expand Down
2 changes: 1 addition & 1 deletion Octokit/Http/IHttpClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public interface IHttpClient : IDisposable


/// <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);
Expand Down
3 changes: 2 additions & 1 deletion Octokit/IGitHubClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down