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

Idea: cache descriptions #17

Open
vreuter opened this issue Aug 30, 2017 · 1 comment
Open

Idea: cache descriptions #17

vreuter opened this issue Aug 30, 2017 · 1 comment

Comments

@vreuter
Copy link
Member

vreuter commented Aug 30, 2017

Sometimes it's easy to infer the data stored in a cache from its name alone. Other times, though, it's cumbersome and inconvenient to give a cache a name that's sufficient to unambiguously convey what it contains. The tradeoff between variable name length and information content becomes an impossible optimization problem.

It'd be cool if, at the time of cache creation (say, as an additional argument to simpleCache), we could make it possible to provide a more thorough description of what the cache contains. This could be stored as a small text file parallel to the cache. Then we could have a function like describeCache that would read the text file associated with the indicated cache and provide the description. This could be extended to a cache folder/subfolder if a text file is present for the folder and/or paired with listCaches.

@nsheff
Copy link
Member

nsheff commented Aug 30, 2017

I like it. It could even be stored in the same cache file, actually.

It could also print the description when you load a cache.

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

No branches or pull requests

2 participants