astropy / astroquery

Functions and classes to access online data resources. Maintainers: @keflavich and @bsipocz and @ceb8
http://astroquery.readthedocs.org/en/latest/
BSD 3-Clause "New" or "Revised" License
696 stars 397 forks source link

Add more examples to modules about usage of the common API #2110

Open bsipocz opened 3 years ago

bsipocz commented 3 years ago

As far as I see only the Simbad, astrometry.net and VO conesearch modules show examples of how to adjust the query timeout. We need to find a way to make it easier for users to discover how to set it themselves, it's probably unlikely that they will visit a separate "Common API" page, but we could e.g. have the same text repeated for all the modules about the timeout and cache.

bsipocz commented 1 year ago

The warnings for the the alfaalfa, sha, ogle modules about the refactoring should be also removed as part of addressing this issue.

bsipocz commented 1 year ago

This is kind of a duplicate of https://github.com/astropy/astroquery/issues/1525