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 note about cache version incompatibility to NWIS Client docs #193

Open
jarq6c opened this issue May 9, 2022 · 2 comments
Open

Add note about cache version incompatibility to NWIS Client docs #193

jarq6c opened this issue May 9, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@jarq6c
Copy link
Collaborator

jarq6c commented May 9, 2022

Owing to #192 , it may behoove us to add a little note to the docs recommending against attempting to re-use caches after upgrading client versions.

@jarq6c jarq6c added the documentation Improvements or additions to documentation label May 9, 2022
@jarq6c
Copy link
Collaborator Author

jarq6c commented May 9, 2022

Thanks @hellkite500 for the suggestion.

it might be worth a quick note in the documentation to clear those caches manually when upgrading versions (or try to detect the cache version and warn/auto regenerate???)

@aaraney
Copy link
Member

aaraney commented Jun 30, 2022

Yeah, I agree. I think this would be a helpful addition to what could be an FAQ section in the nwiw_client docs. Having thought about it, I am hesitant to add a logic into the code base to check for this case, so I think docs are the way to go. Ill try to remember to open a PR to get this added in sometime this week.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants