astropy / astropy/astroquery

Enable doctesting for all narrative documentations

Open
#2,935 1 comment 0 reactions 0 assignees View on GitHub
astrometry.net besancon bug cosmosim Documentation gaia image_cutouts.first ipac.irsa.ibe ukidss utils.tap vamdc vo_conesearch vsa wfau
Dominant language
Python
Stars
791
Forks
451
Avg merge
1d 3h
Merged PRs (30d)
4

Description

Some modules still don't have doctest enabled on their narrative docs. Quick grep for `doctest-skip-all` brings up this list (some may be irrelevant for doctesting, I'll remove those from the list later).

- [ ] docs/api.rst
- [ ] docs/astrometry_net/astrometry_net.rst
- [ ] docs/besancon/besancon.rst
- [ ] docs/cosmosim/cosmosim.rst
- [ ] docs/gaia/gaia.rst
- [ ] docs/image_cutouts/first/first.rst
- [ ] docs/image_cutouts/image_cutouts.rst
- [ ] docs/ipac/irsa/ibe/ibe.rst
- [ ] docs/mocserver/mocserver.rst
- [ ] docs/query.rst
- [x] docs/simbad/simbad.rst
- [ ] docs/testing.rst
- [ ] docs/ukidss/ukidss.rst
- [ ] docs/utils.rst
- [ ] docs/utils/tap.rst
- [ ] docs/vamdc/vamdc.rst
- [x] docs/vizier/vizier.rst
- [ ] docs/vo_conesearch/client.rst
- [ ] docs/vo_conesearch/validator.rst
- [ ] docs/vo_conesearch/vo_conesearch.rst
- [ ] docs/vsa/vsa.rst
- [ ] docs/wfau/wfau.rst

Contributor guide

Open the contributing guide

Research direction

Start by checking the listed .rst files for doctest-skip-all, using the existing docs/simbad/simbad.rst and docs/vizier/vizier.rst entries as completed examples. Confirm which files are relevant for doctesting, enable it for the remaining applicable narrative documentation, and verify the documentation doctests pass.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.