yfinance icon indicating copy to clipboard operation
yfinance copied to clipboard

Documentation Enhancement

Open kschmid opened this issue 2 years ago • 2 comments

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.

kschmid avatar Aug 13 '23 17:08 kschmid

Better would be adding requests_cache expiration to the example, or recommending users read their documentation.

ValueRaider avatar Aug 13 '23 17:08 ValueRaider

Agree: making other options more explicit would be useful. Regarding "reading the documentation": a general pointer to the doc would be useful as well. My main point is: when you read s.th. like this in a beginners guide, you do not assume that critical interactions may occur, without a word of warning.. - any clear warning pointing to the culprit would do.

kschmid avatar Aug 13 '23 19:08 kschmid