astropy / astropy/astroquery

DOC: identify smaller datasets to plug into documentation examples

Open
#2,495 0 comments 0 reactions 0 assignees View on GitHub
Documentation esa esa.esa_hubble
Dominant language
Python
Stars
791
Forks
451
Avg merge
1d 3h
Merged PRs (30d)
4

Description

Some of the code examples in the ESA modules are being skipped for testing as they are pulling largish datasets. It would be wonderful to identify much smaller datasets to include the examples in the testing. (Follow-up for comments in https://github.com/astropy/astroquery/pull/1970#issuecomment-1217958718)

cc @jespinosaar

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the ESA module documentation examples and the follow-up discussion in PR #1970. Identify which examples currently pull large datasets, then find smaller replacements that preserve the examples' purpose and can be exercised during testing. Done means the smaller datasets are identified and the affected examples can be included in documentation tests.

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
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.