Document BaseCache expires value
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Python
- Stars
- 505
- Forks
- 149
- Avg merge
- 2d 13h
- Merged PRs (30d)
- 7
Description
It would be helpful if the value for expires in BaseCache.set was documented. I couldn't find it and the redis/file caches aren't explicit.
Is the expires value guaranteed to be in UTC?
Related #250
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
Start at the BaseCache.set entry point and inspect how the redis and file caches handle the expires value. Document what expires means and whether it is guaranteed to be in UTC; done means the BaseCache API documentation answers these questions consistently with both cache implementations.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100