From ad80ebdd37ba5aa2bb8cdc4638deff05ce9294bd Mon Sep 17 00:00:00 2001 From: Keegan Campbell Date: Thu, 12 Jan 2023 09:52:44 -0800 Subject: [PATCH] Remove instances of lower-case h --- Octokit.Reactive/IObservableGitHubClient.cs | 6 +++--- Octokit.Reactive/ObservableGitHubClient.cs | 2 +- Octokit/IGitHubClient.cs | 4 ++-- Octokit/Models/Response/PagesBuild.cs | 2 +- Octokit/Models/Response/PullRequestReview.cs | 2 +- .../Models/Response/PullRequestReviewComment.cs | 2 +- docs/getting-started.md | 16 ++++++++-------- 7 files changed, 17 insertions(+), 17 deletions(-) diff --git a/Octokit.Reactive/IObservableGitHubClient.cs b/Octokit.Reactive/IObservableGitHubClient.cs index 6532de7994..10cd16e933 100644 --- a/Octokit.Reactive/IObservableGitHubClient.cs +++ b/Octokit.Reactive/IObservableGitHubClient.cs @@ -8,8 +8,8 @@ public interface IObservableGitHubClient : IApiInfoProvider /// /// 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 /// /// /// 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 IObservableMetaClient Meta { get; } IObservableActionsClient Actions { get; } } -} \ No newline at end of file +} diff --git a/Octokit.Reactive/ObservableGitHubClient.cs b/Octokit.Reactive/ObservableGitHubClient.cs index c3899ffc77..7507a382cf 100644 --- a/Octokit.Reactive/ObservableGitHubClient.cs +++ b/Octokit.Reactive/ObservableGitHubClient.cs @@ -66,7 +66,7 @@ public IConnection Connection /// /// 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 /// /// diff --git a/Octokit/IGitHubClient.cs b/Octokit/IGitHubClient.cs index 220cf3c0d7..9bd53eb802 100644 --- a/Octokit/IGitHubClient.cs +++ b/Octokit/IGitHubClient.cs @@ -9,7 +9,7 @@ public interface IGitHubClient : IApiInfoProvider { /// /// 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 /// /// @@ -190,7 +190,7 @@ public interface IGitHubClient : IApiInfoProvider /// Refer to the API documentation for more information: https://docs.github.com/rest/rate-limit /// IRateLimitClient RateLimit { get; } - + /// /// Access GitHub's Markdown API /// diff --git a/Octokit/Models/Response/PagesBuild.cs b/Octokit/Models/Response/PagesBuild.cs index 087f0de045..6b140d32b9 100644 --- a/Octokit/Models/Response/PagesBuild.cs +++ b/Octokit/Models/Response/PagesBuild.cs @@ -5,7 +5,7 @@ namespace Octokit { /// - /// Metadata of a Github Pages build. + /// Metadata of a GitHub Pages build. /// [DebuggerDisplay("{DebuggerDisplay,nq}")] public class PagesBuild diff --git a/Octokit/Models/Response/PullRequestReview.cs b/Octokit/Models/Response/PullRequestReview.cs index c90cc2ca89..38714c9620 100644 --- a/Octokit/Models/Response/PullRequestReview.cs +++ b/Octokit/Models/Response/PullRequestReview.cs @@ -60,7 +60,7 @@ public PullRequestReview(long id, string nodeId, string commitId, User user, str public string Body { get; private set; } /// - /// The URL for this review on Github.com + /// The URL for this review on GitHub.com /// public string HtmlUrl { get; private set; } diff --git a/Octokit/Models/Response/PullRequestReviewComment.cs b/Octokit/Models/Response/PullRequestReviewComment.cs index 44dbf519e3..a39b917a34 100644 --- a/Octokit/Models/Response/PullRequestReviewComment.cs +++ b/Octokit/Models/Response/PullRequestReviewComment.cs @@ -104,7 +104,7 @@ public PullRequestReviewComment(string url, int id, string nodeId, string diffHu public DateTimeOffset UpdatedAt { get; private set; } /// - /// The URL for this comment on Github.com + /// The URL for this comment on GitHub.com /// public string HtmlUrl { get; private set; } diff --git a/docs/getting-started.md b/docs/getting-started.md index 1934e849dd..b52350e895 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -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 @@ -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. @@ -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(); @@ -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).