zoriya/octokit.net
1
0
Fork 0
mirror of https://github.com/zoriya/octokit.net.git synced 2025-12-05 23:06:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

Remove instances of lower-case h (#2655)

Browse Source
This commit is contained in:
Keegan Campbell
2023-01-12 09:56:44 -08:00
committed by GitHub
parent bf72b5e886
commit bf6678543f
7 changed files with 17 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
Octokit.Reactive/IObservableGitHubClient.cs
View File

@@ -8,8 +8,8 @@ namespace Octokit.Reactive
/// <summary> /// <summary>
/// Sets the timeout for the connection between the client and the server. /// 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 /// /// Useful to set a specific timeout for lengthy operations, such as uploading release assets
/// </summary> /// </summary>
/// <remarks> /// <remarks>
/// See more information here: https://technet.microsoft.com/library/system.net.http.httpclient.timeout(v=vs.110).aspx /// See more information here: https://technet.microsoft.com/library/system.net.http.httpclient.timeout(v=vs.110).aspx
@@ -43,4 +43,4 @@ namespace Octokit.Reactive
IObservableMetaClient Meta { get; } IObservableMetaClient Meta { get; }
IObservableActionsClient Actions { get; } IObservableActionsClient Actions { get; }
} }
} }

2
Octokit.Reactive/ObservableGitHubClient.cs
View File

@@ -66,7 +66,7 @@ namespace Octokit.Reactive
/// <summary> /// <summary>
/// Sets the timeout for the connection between the client and the server. /// 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 /// Useful to set a specific timeout for lengthy operations, such as uploading release assets
/// </summary> /// </summary>
/// <remarks> /// <remarks>

4
Octokit/IGitHubClient.cs
View File

@@ -9,7 +9,7 @@ namespace Octokit
{ {
/// <summary> /// <summary>
/// Sets the timeout for the connection between the client and the server. /// 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 /// Useful to set a specific timeout for lengthy operations, such as uploading release assets
/// </summary> /// </summary>
/// <remarks> /// <remarks>
@@ -190,7 +190,7 @@ namespace Octokit
/// Refer to the API documentation for more information: https://docs.github.com/rest/rate-limit /// Refer to the API documentation for more information: https://docs.github.com/rest/rate-limit
/// </remarks> /// </remarks>
IRateLimitClient RateLimit { get; } IRateLimitClient RateLimit { get; }
/// <summary> /// <summary>
/// Access GitHub's Markdown API /// Access GitHub's Markdown API
/// </summary> /// </summary>

2
Octokit/Models/Response/PagesBuild.cs
View File

@@ -5,7 +5,7 @@ using System.Globalization;
namespace Octokit namespace Octokit
{ {
/// <summary> /// <summary>
/// Metadata of a Github Pages build. /// Metadata of a GitHub Pages build.
/// </summary> /// </summary>
[DebuggerDisplay("{DebuggerDisplay,nq}")] [DebuggerDisplay("{DebuggerDisplay,nq}")]
public class PagesBuild public class PagesBuild

2
Octokit/Models/Response/PullRequestReview.cs
View File

@@ -60,7 +60,7 @@ namespace Octokit
public string Body { get; private set; } public string Body { get; private set; }
/// <summary> /// <summary>
/// The URL for this review on Github.com /// The URL for this review on GitHub.com
/// </summary> /// </summary>
public string HtmlUrl { get; private set; } public string HtmlUrl { get; private set; }

2
Octokit/Models/Response/PullRequestReviewComment.cs
View File

@@ -104,7 +104,7 @@ namespace Octokit
public DateTimeOffset UpdatedAt { get; private set; } public DateTimeOffset UpdatedAt { get; private set; }
/// <summary> /// <summary>
/// The URL for this comment on Github.com /// The URL for this comment on GitHub.com
/// </summary> /// </summary>
public string HtmlUrl { get; private set; } public string HtmlUrl { get; private set; }

16
docs/getting-started.md
View File

@@ -41,12 +41,12 @@ var ghe = new Uri("https://github.myenterprise.com/");
var client = new GitHubClient(new ProductHeaderValue("my-cool-app"), ghe); 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 ```csharp
var probe = new EnterpriseProbe(new ProductHeaderValue("my-cool-app")); var probe = new EnterpriseProbe(new ProductHeaderValue("my-cool-app"));
var result = await probe.Probe(new Uri("http://ghe.example.com/")); var result = await probe.Probe(new Uri("http://ghe.example.com/"));
Assert.Equal(EnterpriseProbeResult.Ok, result); Assert.Equal(EnterpriseProbeResult.Ok, result);
``` ```
### Get some data ### Get some data
@@ -69,14 +69,14 @@ var user = await client.User.Current();
### Too Much of a Good Thing: Dealing with API Rate Limits ### 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. 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: Example usage:
```csharp ```csharp
GitHubClient client; GitHubClient client;
//Create & initialize the client here //Create & initialize the client here
// Prior to first API call, this will be null, because it only deals with the last call. // 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 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: Example usage:
```csharp ```csharp
GitHubClient client; GitHubClient client;
//Create & initialize the client here //Create & initialize the client here
var miscellaneousRateLimit = await client.Miscellaneous.GetRateLimits(); var miscellaneousRateLimit = await client.Miscellaneous.GetRateLimits();
@@ -115,6 +115,6 @@ var howManySearchRequestsDoIHaveLeft = searchRateLimit.Remaining;
var whenDoesTheSearchLimitReset = searchRateLimit.Reset; // UTC time 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).