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

Add a warning to the statistics client about caching (#1954)

Browse Source 
* 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
This commit is contained in:
Henrik Andersson
2019-09-16 22:40:12 +10:00
committed by Brendan Forster
parent 1f01b22de5
commit 4f0519ee13
8 changed files with 18 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
Octokit.Reactive/Clients/IObservableStatisticsClient.cs
View File

@@ -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.