Skip to content

Commit bf66785

Browse files
authored
Remove instances of lower-case h (#2655)
1 parent bf72b5e commit bf66785

File tree

7 files changed

+17
-17
lines changed

7 files changed

+17
-17
lines changed

Octokit.Reactive/IObservableGitHubClient.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ public interface IObservableGitHubClient : IApiInfoProvider
88

99
/// <summary>
1010
/// 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
12-
/// Useful to set a specific timeout for lengthy operations, such as uploading release assets
11+
/// GitHub will terminate the request if it takes more than 10 seconds to process the request
12+
/// /// Useful to set a specific timeout for lengthy operations, such as uploading release assets
1313
/// </summary>
1414
/// <remarks>
1515
/// See more information here: https://technet.microsoft.com/library/system.net.http.httpclient.timeout(v=vs.110).aspx
@@ -43,4 +43,4 @@ public interface IObservableGitHubClient : IApiInfoProvider
4343
IObservableMetaClient Meta { get; }
4444
IObservableActionsClient Actions { get; }
4545
}
46-
}
46+
}

Octokit.Reactive/ObservableGitHubClient.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ public IConnection Connection
6666

6767
/// <summary>
6868
/// Sets the timeout for the connection between the client and the server.
69-
/// Github will terminate the request if it takes more than 10 seconds to process the request
69+
/// GitHub will terminate the request if it takes more than 10 seconds to process the request
7070
/// Useful to set a specific timeout for lengthy operations, such as uploading release assets
7171
/// </summary>
7272
/// <remarks>

Octokit/IGitHubClient.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ public interface IGitHubClient : IApiInfoProvider
99
{
1010
/// <summary>
1111
/// 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
12+
/// GitHub will terminate the request if it takes more than 10 seconds to process the request
1313
/// Useful to set a specific timeout for lengthy operations, such as uploading release assets
1414
/// </summary>
1515
/// <remarks>
@@ -190,7 +190,7 @@ public interface IGitHubClient : IApiInfoProvider
190190
/// Refer to the API documentation for more information: https://docs.github.com/rest/rate-limit
191191
/// </remarks>
192192
IRateLimitClient RateLimit { get; }
193-
193+
194194
/// <summary>
195195
/// Access GitHub's Markdown API
196196
/// </summary>

Octokit/Models/Response/PagesBuild.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
namespace Octokit
66
{
77
/// <summary>
8-
/// Metadata of a Github Pages build.
8+
/// Metadata of a GitHub Pages build.
99
/// </summary>
1010
[DebuggerDisplay("{DebuggerDisplay,nq}")]
1111
public class PagesBuild

Octokit/Models/Response/PullRequestReview.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ public PullRequestReview(long id, string nodeId, string commitId, User user, str
6060
public string Body { get; private set; }
6161

6262
/// <summary>
63-
/// The URL for this review on Github.com
63+
/// The URL for this review on GitHub.com
6464
/// </summary>
6565
public string HtmlUrl { get; private set; }
6666

Octokit/Models/Response/PullRequestReviewComment.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ public PullRequestReviewComment(string url, int id, string nodeId, string diffHu
104104
public DateTimeOffset UpdatedAt { get; private set; }
105105

106106
/// <summary>
107-
/// The URL for this comment on Github.com
107+
/// The URL for this comment on GitHub.com
108108
/// </summary>
109109
public string HtmlUrl { get; private set; }
110110

docs/getting-started.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -41,12 +41,12 @@ var ghe = new Uri("https://github.myenterprise.com/");
4141
var client = new GitHubClient(new ProductHeaderValue("my-cool-app"), ghe);
4242
```
4343

44-
You can use the `EnterpriseProbe` class to test whether a URL points to a Github Enterprise instance.
44+
You can use the `EnterpriseProbe` class to test whether a URL points to a GitHub Enterprise instance.
4545

4646
```csharp
4747
var probe = new EnterpriseProbe(new ProductHeaderValue("my-cool-app"));
4848
var result = await probe.Probe(new Uri("http://ghe.example.com/"));
49-
Assert.Equal(EnterpriseProbeResult.Ok, result);
49+
Assert.Equal(EnterpriseProbeResult.Ok, result);
5050
```
5151

5252
### Get some data
@@ -69,14 +69,14 @@ var user = await client.User.Current();
6969

7070
### Too Much of a Good Thing: Dealing with API Rate Limits
7171

72-
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.
72+
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.
7373

7474
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.
7575

7676
Example usage:
7777

7878
```csharp
79-
GitHubClient client;
79+
GitHubClient client;
8080
//Create & initialize the client here
8181
8282
// Prior to first API call, this will be null, because it only deals with the last call.
@@ -90,12 +90,12 @@ var howManyRequestsDoIHaveLeft = rateLimit?.Remaining;
9090
var whenDoesTheLimitReset = rateLimit?.Reset; // UTC time
9191
```
9292

93-
However, if in some cases you need to get the Rate Limit directly from Github, you should call `GitHubClient.Miscellaneous.GetRateLimits()`.
93+
However, if in some cases you need to get the Rate Limit directly from GitHub, you should call `GitHubClient.Miscellaneous.GetRateLimits()`.
9494

9595
Example usage:
9696

9797
```csharp
98-
GitHubClient client;
98+
GitHubClient client;
9999
//Create & initialize the client here
100100
101101
var miscellaneousRateLimit = await client.Miscellaneous.GetRateLimits();
@@ -115,6 +115,6 @@ var howManySearchRequestsDoIHaveLeft = searchRateLimit.Remaining;
115115
var whenDoesTheSearchLimitReset = searchRateLimit.Reset; // UTC time
116116
```
117117

118-
An authenticated client will have a significantly higher limit than an anonymous client.
118+
An authenticated client will have a significantly higher limit than an anonymous client.
119119

120-
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).
120+
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 commit comments

Comments
 (0)