Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a warning to the statistics client about caching #1954

Merged
merged 5 commits into from
Sep 16, 2019
Merged

Add a warning to the statistics client about caching #1954

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a7203f4
Add a warning to the statistics client about caching
hnrkndrssn Mar 15, 2019
b116429
Simplify note about caching and direct users to the API docs
hnrkndrssn Mar 21, 2019
0854564
Merge the summary sections as the 2nd section is ignored in VS
hnrkndrssn Mar 30, 2019
9ca9149
squash duplicate summary tags together
shiftkey Sep 12, 2019
9b76f9b
Also squash these lines
shiftkey Sep 12, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion Octokit.Reactive/Clients/IObservableRepositoriesClient.cs
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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