astroquery icon indicating copy to clipboard operation
astroquery copied to clipboard

DOC: Esasky to cut back download for documentation

Open bsipocz opened this issue 3 years ago • 3 comments

There is some repetition in the esasky docs, and while I try to finish up #1971, the doctest already runs for 10+ minutes and downloads 1G+ data. Both should ideally be cut back.

cc @imbasimba

bsipocz avatar Oct 04 '22 04:10 bsipocz

Wow! Yeah, these docs were not designed with limited data useage in mind. I'll allocate some time later in the week or next week to see if I can update the examples to download fewer and smaller files.

imbasimba avatar Oct 04 '22 05:10 imbasimba

Thanks. It's somewhat contradictional to cut back on documentation, but I like to think that it's very valuable to be able to run the actual snippets we have in there, thus the tradeback.

Also, this is not at all urgent, and let me just finish up enabling the doctesting on the current one, I'm almost ready, but it slowed down now that I'm more than halfway through as I'm waiting for the test to run :)

bsipocz avatar Oct 04 '22 06:10 bsipocz

Agreed :)

imbasimba avatar Oct 04 '22 06:10 imbasimba

I had to deal with new high priority tasks there for a while, but I finally got around to improve the docs: https://github.com/astropy/astroquery/pull/2614

imbasimba avatar Nov 29 '22 10:11 imbasimba

Got addressed, I just forgot to cross-link. Thanks again!

bsipocz avatar Dec 01 '22 07:12 bsipocz