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.

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

Conversation

hnrkndrssn
Copy link
Contributor

I had to add the warning to the Statistics property as well on the *RepositoriesClient otherwise the warning won't show up in intellisense when you do github.Repositories.Statistics

Fixes #1814

@ryangribble
Copy link
Contributor

Unless I'm totally wrong on this, I thought the <remarks> tag didnt appear in intellisense - and it was only <summary> that does?

I'm also wondering whether we should embed the full text from GitHub here (what if the text changes in the future?) or whether we could just have a simpler note like "Note that the GitHub API uses caching on these endpoints, see https://developer.github.com/v3/repos/statistics/#a-word-about-caching for futther details"

Also update to use summary instead of remarks
@shiftkey shiftkey dismissed ryangribble’s stale review September 12, 2019 23:26

This has now been sorted

@shiftkey
Copy link
Member

release_notes: Add comment about caching when calling the repository statistics endpoint

@shiftkey shiftkey merged commit 4f0519e into octokit:master Sep 16, 2019
@nickfloyd nickfloyd added Type: Bug Something isn't working as documented and removed category: bug labels Oct 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Bug Something isn't working as documented
Projects
None yet
Development

Successfully merging this pull request may close these issues.

add warning from docs about statistics client data potentially being cached
4 participants