INCATools / INCATools/ontology-access-kit
Update docs on pystow/sqlite cache management
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 198
- Forks
- 35
- Avg merge
- 3d 4h
- Merged PRs (30d)
- 1
Description
We have a FAQ entry "My cached SQLite ontology is out of date"
https://incatools.github.io/ontology-access-kit/faq/troubleshooting.html#my-cached-sqlite-ontology-is-out-of-date
This recommends low-level navigating to the pystow `.data` directly and explicitly clearing old .db files.
However, since 0.6.17 we have had much better cache management tools captured in the release notes here:
https://github.com/INCATools/ontology-access-kit/releases/tag/v0.6.17
We have two commands:
- https://incatools.github.io/ontology-access-kit/cli.html#runoak-cache-ls
- https://incatools.github.io/ontology-access-kit/cli.html#runoak-cache-clear
And also a global option:
` --caching CACHE-POLICY Set the cache management policy`
Contributor guide
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
Open the FAQ entry “My cached SQLite ontology is out of date” in troubleshooting.html and compare its guidance with the v0.6.17 release notes and the runoak cache-ls and cache-clear CLI documentation. Update the FAQ to recommend the cache management commands and the --caching CACHE-POLICY option instead of manually navigating pystow’s .data directory and deleting .db files.
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
- Clearly specified
- Newbie friendliness
- 72/100