astropy / astropy/astroquery

Add more examples to modules about usage of the common API

Open
#2,110 2 comments 0 reactions 0 assignees View on GitHub
Documentation package-novice
Dominant language
Python
Stars
791
Forks
451
Avg merge
1d 3h
Merged PRs (30d)
4

Description

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.

Contributor guide

Open the contributing guide

Research direction

Review the Simbad, astrometry.net, and VO conesearch module documentation alongside the separate Common API page. Compare how query timeout and cache usage are currently explained, then identify the other modules that need the same guidance. Done means users can discover and follow the timeout and cache examples from the relevant module documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
28/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.