[Documentation] Warn about usage of cache
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Python
- Stars
- 77
- Forks
- 7
- Avg merge
- 10h 32m
- Merged PRs (30d)
- 12
Description
The cache is not intended for long term storage, this means during minor version changes e.g., from 1.4.X to 1.5.X the backwards compatibility of the cache directory was broken.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the documentation that describes the cache and its intended use. Update it to warn that the cache is not long-term storage and that cache-directory compatibility can break across minor versions such as 1.4.X to 1.5.X; the documentation should clearly communicate this limitation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 40/100