From 4f0519ee13cf7345405ad9917e9f7a60a36d6535 Mon Sep 17 00:00:00 2001 From: Henrik Andersson Date: Mon, 16 Sep 2019 22:40:12 +1000 Subject: [PATCH] Add a warning to the statistics client about caching (#1954) * 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 --- Octokit.Reactive/Clients/IObservableRepositoriesClient.cs | 4 +++- Octokit.Reactive/Clients/IObservableStatisticsClient.cs | 2 ++ Octokit.Reactive/Clients/ObservableRepositoriesClient.cs | 2 ++ Octokit.Reactive/Clients/ObservableStatisticsClient.cs | 2 ++ Octokit/Clients/IRepositoriesClient.cs | 4 +++- Octokit/Clients/IStatisticsClient.cs | 2 ++ Octokit/Clients/RepositoriesClient.cs | 2 ++ Octokit/Clients/StatisticsClient.cs | 2 ++ 8 files changed, 18 insertions(+), 2 deletions(-) diff --git a/Octokit.Reactive/Clients/IObservableRepositoriesClient.cs b/Octokit.Reactive/Clients/IObservableRepositoriesClient.cs index 2843a46c..7d3218e8 100644 --- a/Octokit.Reactive/Clients/IObservableRepositoriesClient.cs +++ b/Octokit.Reactive/Clients/IObservableRepositoriesClient.cs @@ -201,7 +201,9 @@ namespace Octokit.Reactive IObservableDeploymentsClient Deployment { get; } /// - /// 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 word about caching for more details. /// /// /// See the Statistics API documentation for more details diff --git a/Octokit.Reactive/Clients/IObservableStatisticsClient.cs b/Octokit.Reactive/Clients/IObservableStatisticsClient.cs index 16460365..324fc951 100644 --- a/Octokit.Reactive/Clients/IObservableStatisticsClient.cs +++ b/Octokit.Reactive/Clients/IObservableStatisticsClient.cs @@ -5,6 +5,8 @@ namespace Octokit.Reactive { /// /// A client for GitHub's Repository Statistics API. + /// Note that the GitHub API uses caching on these endpoints, + /// see a word about caching for more details. /// /// /// See the Repository Statistics API documentation for more information. diff --git a/Octokit.Reactive/Clients/ObservableRepositoriesClient.cs b/Octokit.Reactive/Clients/ObservableRepositoriesClient.cs index e6f07b9d..1f399145 100644 --- a/Octokit.Reactive/Clients/ObservableRepositoriesClient.cs +++ b/Octokit.Reactive/Clients/ObservableRepositoriesClient.cs @@ -315,6 +315,8 @@ namespace Octokit.Reactive /// /// Client for GitHub's Repository Statistics API + /// Note that the GitHub API uses caching on these endpoints, + /// see a word about caching for more details. /// /// /// See the Statistics API documentation for more details diff --git a/Octokit.Reactive/Clients/ObservableStatisticsClient.cs b/Octokit.Reactive/Clients/ObservableStatisticsClient.cs index e1f3b3bf..4f5f98b8 100644 --- a/Octokit.Reactive/Clients/ObservableStatisticsClient.cs +++ b/Octokit.Reactive/Clients/ObservableStatisticsClient.cs @@ -6,6 +6,8 @@ namespace Octokit.Reactive { /// /// A client for GitHub's Repository Statistics API. + /// Note that the GitHub API uses caching on these endpoints, + /// see a word about caching for more details. /// /// /// See the Repository Statistics API documentation for more information. diff --git a/Octokit/Clients/IRepositoriesClient.cs b/Octokit/Clients/IRepositoriesClient.cs index 617b93c2..ab9e31fb 100644 --- a/Octokit/Clients/IRepositoriesClient.cs +++ b/Octokit/Clients/IRepositoriesClient.cs @@ -316,7 +316,9 @@ namespace Octokit IDeploymentsClient Deployment { get; } /// - /// 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 word about caching for more details. /// /// /// See the Statistics API documentation for more details diff --git a/Octokit/Clients/IStatisticsClient.cs b/Octokit/Clients/IStatisticsClient.cs index 9802ef75..f7731c86 100644 --- a/Octokit/Clients/IStatisticsClient.cs +++ b/Octokit/Clients/IStatisticsClient.cs @@ -6,6 +6,8 @@ namespace Octokit { /// /// A client for GitHub's Repository Statistics API. + /// Note that the GitHub API uses caching on these endpoints, + /// see a word about caching for more details. /// /// /// See the Repository Statistics API documentation for more information. diff --git a/Octokit/Clients/RepositoriesClient.cs b/Octokit/Clients/RepositoriesClient.cs index b3106571..20574b12 100644 --- a/Octokit/Clients/RepositoriesClient.cs +++ b/Octokit/Clients/RepositoriesClient.cs @@ -471,6 +471,8 @@ namespace Octokit /// /// Client for GitHub's Repository Statistics API + /// Note that the GitHub API uses caching on these endpoints, + /// see a word about caching for more details. /// /// /// See the Statistics API documentation for more details diff --git a/Octokit/Clients/StatisticsClient.cs b/Octokit/Clients/StatisticsClient.cs index 99a19077..057e8900 100644 --- a/Octokit/Clients/StatisticsClient.cs +++ b/Octokit/Clients/StatisticsClient.cs @@ -7,6 +7,8 @@ namespace Octokit { /// /// A client for GitHub's Repository Statistics API. + /// Note that the GitHub API uses caching on these endpoints, + /// see a word about caching for more details. /// /// /// See the Repository Statistics API documentation for more information.