Skip to content

Commit

Permalink
Add a warning to the statistics client about caching (#1954)
Browse files Browse the repository at this point in the history
* Add a warning to the statistics client about caching

* Simplify note about caching and direct users to the API docs

Also update to use summary instead of remarks

* Merge the summary sections as the 2nd section is ignored in VS

* squash duplicate summary tags together

* Also squash these lines
  • Loading branch information
hnrkndrssn authored and shiftkey committed Sep 16, 2019
1 parent 1f01b22 commit 4f0519e
Show file tree
Hide file tree
Showing 8 changed files with 18 additions and 2 deletions.
4 changes: 3 additions & 1 deletion Octokit.Reactive/Clients/IObservableRepositoriesClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,9 @@ public interface IObservableRepositoriesClient
IObservableDeploymentsClient Deployment { get; }

/// <summary>
/// Client for GitHub's Repository Statistics API
/// Client for GitHub's Repository Statistics API.
/// Note that the GitHub API uses caching on these endpoints,
/// see <a href="https://developer.github.com/v3/repos/statistics/#a-word-about-caching">a word about caching</a> for more details.
/// </summary>
/// <remarks>
/// See the <a href="http://developer.github.com/v3/repos/statistics/">Statistics API documentation</a> for more details
Expand Down
2 changes: 2 additions & 0 deletions Octokit.Reactive/Clients/IObservableStatisticsClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ namespace Octokit.Reactive
{
/// <summary>
/// A client for GitHub's Repository Statistics API.
/// Note that the GitHub API uses caching on these endpoints,
/// see <a href="https://developer.github.com/v3/repos/statistics/#a-word-about-caching">a word about caching</a> for more details.
/// </summary>
/// <remarks>
/// See the <a href="https://developer.github.com/v3/repos/statistics/">Repository Statistics API documentation</a> for more information.
Expand Down
2 changes: 2 additions & 0 deletions Octokit.Reactive/Clients/ObservableRepositoriesClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -315,6 +315,8 @@ public IObservable<Repository> GetAllForOrg(string organization, ApiOptions opti

/// <summary>
/// Client for GitHub's Repository Statistics API
/// Note that the GitHub API uses caching on these endpoints,
/// see <a href="https://developer.github.com/v3/repos/statistics/#a-word-about-caching">a word about caching</a> for more details.
/// </summary>
/// <remarks>
/// See the <a href="http://developer.github.com/v3/repos/statistics/">Statistics API documentation</a> for more details
Expand Down
2 changes: 2 additions & 0 deletions Octokit.Reactive/Clients/ObservableStatisticsClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ namespace Octokit.Reactive
{
/// <summary>
/// A client for GitHub's Repository Statistics API.
/// Note that the GitHub API uses caching on these endpoints,
/// see <a href="https://developer.github.com/v3/repos/statistics/#a-word-about-caching">a word about caching</a> for more details.
/// </summary>
/// <remarks>
/// See the <a href="https://developer.github.com/v3/repos/statistics/">Repository Statistics API documentation</a> for more information.
Expand Down
4 changes: 3 additions & 1 deletion Octokit/Clients/IRepositoriesClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -316,7 +316,9 @@ public interface IRepositoriesClient
IDeploymentsClient Deployment { get; }

/// <summary>
/// Client for GitHub's Repository Statistics API
/// Client for GitHub's Repository Statistics API.
/// Note that the GitHub API uses caching on these endpoints,
/// see <a href="https://developer.github.com/v3/repos/statistics/#a-word-about-caching">a word about caching</a> for more details.
/// </summary>
/// <remarks>
/// See the <a href="http://developer.github.com/v3/repos/statistics/">Statistics API documentation</a> for more details
Expand Down
2 changes: 2 additions & 0 deletions Octokit/Clients/IStatisticsClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ namespace Octokit
{
/// <summary>
/// A client for GitHub's Repository Statistics API.
/// Note that the GitHub API uses caching on these endpoints,
/// see <a href="https://developer.github.com/v3/repos/statistics/#a-word-about-caching">a word about caching</a> for more details.
/// </summary>
/// <remarks>
/// See the <a href="https://developer.github.com/v3/repos/statistics/">Repository Statistics API documentation</a> for more information.
Expand Down
2 changes: 2 additions & 0 deletions Octokit/Clients/RepositoriesClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -471,6 +471,8 @@ public Task<IReadOnlyList<Repository>> GetAllForOrg(string organization, ApiOpti

/// <summary>
/// Client for GitHub's Repository Statistics API
/// Note that the GitHub API uses caching on these endpoints,
/// see <a href="https://developer.github.com/v3/repos/statistics/#a-word-about-caching">a word about caching</a> for more details.
/// </summary>
/// <remarks>
/// See the <a href="http://developer.github.com/v3/repos/statistics/">Statistics API documentation</a> for more details
Expand Down
2 changes: 2 additions & 0 deletions Octokit/Clients/StatisticsClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ namespace Octokit
{
/// <summary>
/// A client for GitHub's Repository Statistics API.
/// Note that the GitHub API uses caching on these endpoints,
/// see <a href="https://developer.github.com/v3/repos/statistics/#a-word-about-caching">a word about caching</a> for more details.
/// </summary>
/// <remarks>
/// See the <a href="https://developer.github.com/v3/repos/statistics/">Repository Statistics API documentation</a> for more information.
Expand Down

0 comments on commit 4f0519e

Please sign in to comment.