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 warning from docs about statistics client data potentially being cached #1814

Closed
M-Zuber opened this issue Jun 12, 2018 · 3 comments · Fixed by #1954
Closed

add warning from docs about statistics client data potentially being cached #1814

M-Zuber opened this issue Jun 12, 2018 · 3 comments · Fixed by #1954
Labels
Status: Up for grabs Issues that are ready to be worked on by anyone Type: Documentation Improvements or additions to documentation

Comments

@M-Zuber
Copy link
Contributor

M-Zuber commented Jun 12, 2018

The documentation for the statistics client includes a warning that the data might be cached.
(https://developer.github.com/v3/repos/statistics/#a-word-about-caching)
It might be worthwhile to include that warning or a link to it, in the intellisene on the methods

@hnrkndrssn
Copy link
Contributor

I started looking into this, but had a thought before I did any work on it.

Would it be necessary to have the warning in the intellisense of every method (that's a lot of copy-🍝) or would it be enough to add it just to the intellisense of the class and constructor?

@ryangribble
Copy link
Contributor

Nobody would really be constructing the RepositoryStatisticsClient themselves I dont think, so probably just in the actual class description intellisense would be fine. I also think this would be fine since that paralllels what the official docs do (a single call out at the top, for the whole client) rather than repeating it on each method 👍

@M-Zuber
Copy link
Contributor Author

M-Zuber commented Mar 10, 2019

That would show up when a user does client.RepositoryStatistics before dotting into an actual method?
If so, then you have my +1

@nickfloyd nickfloyd added Type: Documentation Improvements or additions to documentation Status: Up for grabs Issues that are ready to be worked on by anyone and removed category: docs-and-samples labels Oct 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Up for grabs Issues that are ready to be worked on by anyone Type: Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants