Improve caching documentation

[keflavich]

There's very little documentation on the caching process, and users sometimes complain about the cache filling up.

In short, we need documentation stating:

• The default location is ~/.astropy/cache/astroquery
• get_cache_dir can be used to find the cache dir
• some documentation about how clear_download_cache can be used to clear the cache, with examples

[Edit]:

• add a repeated troubleshooting section to every module's narrative docs that refers to clearing the cache (and upgrading the version) as possible ways to fix failing queries.
• possibly link the above in the class docstrings, too (along with timeout, row_limit, etc.)

[bsipocz]

This is a duplication of #300, but I'm closing that one given there are more concrete todo items on this one.

[keflavich]

Dangit, I searched for 'cache' but not 'caching'. My memory fails.

[bsipocz]

I only remembered because of the recent simbad issues 😄

[Himanshu-Garg]

Anyone on this?

[bsipocz]

no one, please go ahead!

[Himanshu-Garg]

Can you pls mention the doc where i have to insert the new info

I cannot find it in docs folder

[Himanshu-Garg]

here cache folder is not showing in the cloned repo because the repo cloned is of older version but the following page is available in newer version-
http://docs.astropy.org/en/stable/api/astropy.config.get_cache_dir.html#astropy.config.get_cache_dir

so, how to make changes in this page?

[UdokaVrede]

can I take this up, I am an outreachy applicant

[bsipocz]

I'm afraid this is a bit miscategorized to be package-novice in a sense it is best suited for users running into cache issues. E.g. we cannot give much guidance on where to document these things to be the most effective, where the users would most likely see it.
Maybe a frequent solutions to issues on the opening page, Troubleshouting?

So you certainly have a go with it, but it would be the most impactful if there was input from users. You can reach some of them on the astroquery slack channel, or the astropy mailing list, or ping the people in issues from the past 1-2 years where the solution was something cache related where the extra docs would help.

So, in summary, you've welcome to work on this, but it is not a straightforward issue because of the meta layer.

[UdokaVrede]

I DID NOT KNOW IT WAS THIS VAST, I WOULD SKIP THIS WHILE I GET FAMILIAR WITH ASTROPY. I WOULD APPRECIATE LINKS TO package-novice issues.Thanks

…

On Tue, Oct 20, 2020 at 6:30 PM Brigitta Sipőcz ***@***.***> wrote: I'm afraid this is a bit miscategorized to be package-novice in a sense it is best suited for users running into cache issues. E.g. we cannot give much guidance on where to document these things to be the most effective, where the users would most likely see it. Maybe a frequent solutions to issues on the opening page, Troubleshouting? So you certainly have a go with it, but it would be the most impactful if there was input from users. You can reach some of them on the astroquery slack channel, or the astropy mailing list, or ping the people in issues from the past 1-2 years where the solution was something cache related where the extra docs would help. So, in summary, you've welcome to work on this, but it is not a straightforward issue because of the meta layer. — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#1239 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/APFTMSFCDVTDTHS7SLBUQEDSLXCLHANCNFSM4FV2XTQA> .