astropy / astropy/astroquery

Generated API doc for query_region has a wrong description

Open
#1,470 4 comments 0 reactions 0 assignees View on GitHub
bug Documentation infrastructure
Dominant language
Python
Stars
791
Forks
451
Avg merge
1d 3h
Merged PRs (30d)
4

Description

See https://astroquery.readthedocs.io/en/latest/api/astroquery.vizier.VizierClass.html#astroquery.vizier.VizierClass.query_region

The description of `query_region` (which is generated with its API doc) is identical to the description of `query_region_async`.

Contributor guide

Open the contributing guide

Research direction

Start with the generated API documentation for VizierClass.query_region and compare its description with query_region_async. Trace those two entry points to their source documentation and verify that the generated descriptions accurately distinguish the methods.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.