astropy / astropy/astroquery

Better document API expectations

Open
#1,525 1 comment 2 reactions 0 assignees View on GitHub
bug Documentation template module
Dominant language
Python
Stars
791
Forks
451
Avg merge
1d 3h
Merged PRs (30d)
4

Description

It came up recently that we don't document API expectations (e.g https://github.com/astropy/astroquery/issues/1523), e.g returning `NoResultsWarning`s for empty results rather than errors, etc.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing issue 1523 and the existing astroquery API documentation to identify where expectations are currently missing. Define the documentation scope around behaviors such as returning NoResultsWarnings for empty results rather than errors; done means the relevant API expectations are consistently documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.