ranaroussi / ranaroussi/yfinance
Documentation Enhancement
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 25.3k
- Forks
- 3.4k
- Avg merge
- 4d 16h
- Merged PRs (30d)
- 5
Description
In the smarter scraping section in the intro guide, it would be useful, if there would be a disclaimer that the proposed code basically indefinitely caches requests. Hence, if you use a disk cache (as proposed), it might easily lead to a situation where outdated information is returned.
Hence, a disclaimer like:
"note that this does cache the underlying http requests indefinitely and may lead to using outdated information in updates. Refer to the documentation of corresponding requests_cache component for further setup information"
might be useful for newbies to this part of the python universe.
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 intro guide and locate the smarter scraping section. Add a disclaimer that the proposed disk cache stores underlying HTTP requests indefinitely and may return outdated information, with a reference to the requests_cache documentation for further setup; done means the warning is visible to newcomers.
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
- Clearly specified
- Newbie friendliness
- 55/100