Skip to content

Commit

Permalink
Remove instances of lower-case h (#2655)
Browse files Browse the repository at this point in the history
  • Loading branch information
kfcampbell authored Jan 12, 2023
1 parent bf72b5e commit bf66785
Show file tree
Hide file tree
Showing 7 changed files with 17 additions and 17 deletions.
6 changes: 3 additions & 3 deletions Octokit.Reactive/IObservableGitHubClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ public interface IObservableGitHubClient : IApiInfoProvider

/// <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
Expand Down Expand Up @@ -43,4 +43,4 @@ public interface IObservableGitHubClient : IApiInfoProvider
IObservableMetaClient Meta { get; }
IObservableActionsClient Actions { get; }
}
}
}
2 changes: 1 addition & 1 deletion Octokit.Reactive/ObservableGitHubClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ public IConnection Connection

/// <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>
Expand Down
4 changes: 2 additions & 2 deletions Octokit/IGitHubClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ public interface IGitHubClient : IApiInfoProvider
{
/// <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>
Expand Down Expand Up @@ -190,7 +190,7 @@ public interface IGitHubClient : IApiInfoProvider
/// Refer to the API documentation for more information: https://docs.github.com/rest/rate-limit
/// </remarks>
IRateLimitClient RateLimit { get; }

/// <summary>
/// Access GitHub's Markdown API
/// </summary>
Expand Down
2 changes: 1 addition & 1 deletion Octokit/Models/Response/PagesBuild.cs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
namespace Octokit
{
/// <summary>
/// Metadata of a Github Pages build.
/// Metadata of a GitHub Pages build.
/// </summary>
[DebuggerDisplay("{DebuggerDisplay,nq}")]
public class PagesBuild
Expand Down
2 changes: 1 addition & 1 deletion Octokit/Models/Response/PullRequestReview.cs
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ public PullRequestReview(long id, string nodeId, string commitId, User user, str
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; }

Expand Down
2 changes: 1 addition & 1 deletion Octokit/Models/Response/PullRequestReviewComment.cs
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ public PullRequestReviewComment(string url, int id, string nodeId, string diffHu
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; }

Expand Down
16 changes: 8 additions & 8 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,12 @@ 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"));
var result = await probe.Probe(new Uri("http://ghe.example.com/"));
Assert.Equal(EnterpriseProbeResult.Ok, result);
Assert.Equal(EnterpriseProbeResult.Ok, result);
```

### Get some data
Expand All @@ -69,14 +69,14 @@ 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.

Example usage:

```csharp
GitHubClient client;
GitHubClient client;
//Create & initialize the client here
// Prior to first API call, this will be null, because it only deals with the last call.
Expand All @@ -90,12 +90,12 @@ 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:

```csharp
GitHubClient client;
GitHubClient client;
//Create & initialize the client here
var miscellaneousRateLimit = await client.Miscellaneous.GetRateLimits();
Expand All @@ -115,6 +115,6 @@ var howManySearchRequestsDoIHaveLeft = searchRateLimit.Remaining;
var whenDoesTheSearchLimitReset = searchRateLimit.Reset; // UTC time
```

An authenticated client will have a significantly higher limit than an anonymous client.
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).

0 comments on commit bf66785

Please sign in to comment.