mirror of
https://github.com/zoriya/octokit.net.git
synced 2025-12-06 07:16:09 +00:00
Remove instances of lower-case h (#2655)
This commit is contained in:
@@ -8,8 +8,8 @@ namespace Octokit.Reactive
|
||||
|
||||
/// <summary>
|
||||
/// 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
|
||||
/// 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>
|
||||
/// See more information here: https://technet.microsoft.com/library/system.net.http.httpclient.timeout(v=vs.110).aspx
|
||||
|
||||
@@ -66,7 +66,7 @@ namespace Octokit.Reactive
|
||||
|
||||
/// <summary>
|
||||
/// 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
|
||||
/// 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>
|
||||
|
||||
@@ -9,7 +9,7 @@ namespace Octokit
|
||||
{
|
||||
/// <summary>
|
||||
/// 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
|
||||
/// 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>
|
||||
|
||||
@@ -5,7 +5,7 @@ using System.Globalization;
|
||||
namespace Octokit
|
||||
{
|
||||
/// <summary>
|
||||
/// Metadata of a Github Pages build.
|
||||
/// Metadata of a GitHub Pages build.
|
||||
/// </summary>
|
||||
[DebuggerDisplay("{DebuggerDisplay,nq}")]
|
||||
public class PagesBuild
|
||||
|
||||
@@ -60,7 +60,7 @@ namespace Octokit
|
||||
public string Body { get; private set; }
|
||||
|
||||
/// <summary>
|
||||
/// The URL for this review on Github.com
|
||||
/// The URL for this review on GitHub.com
|
||||
/// </summary>
|
||||
public string HtmlUrl { get; private set; }
|
||||
|
||||
|
||||
@@ -104,7 +104,7 @@ namespace Octokit
|
||||
public DateTimeOffset UpdatedAt { get; private set; }
|
||||
|
||||
/// <summary>
|
||||
/// The URL for this comment on Github.com
|
||||
/// The URL for this comment on GitHub.com
|
||||
/// </summary>
|
||||
public string HtmlUrl { get; private set; }
|
||||
|
||||
|
||||
@@ -41,7 +41,7 @@ var ghe = new Uri("https://github.myenterprise.com/");
|
||||
var client = new GitHubClient(new ProductHeaderValue("my-cool-app"), ghe);
|
||||
```
|
||||
|
||||
You can use the `EnterpriseProbe` class to test whether a URL points to a Github Enterprise instance.
|
||||
You can use the `EnterpriseProbe` class to test whether a URL points to a GitHub Enterprise instance.
|
||||
|
||||
```csharp
|
||||
var probe = new EnterpriseProbe(new ProductHeaderValue("my-cool-app"));
|
||||
@@ -69,7 +69,7 @@ var user = await client.User.Current();
|
||||
|
||||
### Too Much of a Good Thing: Dealing with API Rate Limits
|
||||
|
||||
Like any popular API, Github needs to throttle some requests. The OctoKit.NET client allows you to get some insight into how many requests you have left and when you can start making requests again.
|
||||
Like any popular API, GitHub needs to throttle some requests. The OctoKit.NET client allows you to get some insight into how many requests you have left and when you can start making requests again.
|
||||
|
||||
In fact, there are two ways to get the Rate Limits via OctoKit.NET. Calling `GitHubClient.GetLastApiInfo()` returns the Rate Limit status which has been returned with the last api call. So, calling `GitHubClient.GetLastApiInfo()` will not send any extra HTTP requests to GitHub's servers.
|
||||
|
||||
@@ -90,7 +90,7 @@ var howManyRequestsDoIHaveLeft = rateLimit?.Remaining;
|
||||
var whenDoesTheLimitReset = rateLimit?.Reset; // UTC time
|
||||
```
|
||||
|
||||
However, if in some cases you need to get the Rate Limit directly from Github, you should call `GitHubClient.Miscellaneous.GetRateLimits()`.
|
||||
However, if in some cases you need to get the Rate Limit directly from GitHub, you should call `GitHubClient.Miscellaneous.GetRateLimits()`.
|
||||
|
||||
Example usage:
|
||||
|
||||
@@ -117,4 +117,4 @@ var whenDoesTheSearchLimitReset = searchRateLimit.Reset; // UTC time
|
||||
|
||||
An authenticated client will have a significantly higher limit than an anonymous client.
|
||||
|
||||
For more information on the API and understanding rate limits, you may want to consult [the Github API docs on rate limits](https://developer.github.com/v3/#rate-limiting).
|
||||
For more information on the API and understanding rate limits, you may want to consult [the GitHub API docs on rate limits](https://developer.github.com/v3/#rate-limiting).
|
||||
|
||||
Reference in New Issue
Block a user