Documentation for SIA2: How are units supposed to be specified?
- Dominant language
- Python
- Stars
- 88
- Forks
- 64
- Avg merge
- 38m
- Merged PRs (30d)
- 1
Description
https://github.com/astropy/pyvo/blob/4a6f52fc480cf8f4aadfac2317290899cdb8c258/pyvo/dal/sia2.py#L33-L42
There are a few problems with the docstring here:
" (ra, dec, radius) - for CIRCLE. (angle units - defaults to) " defaults to what? Presumably degrees?
" (long1, long2, lat1, lat2) - for RANGE (angle units required) "
Does this mean that the user must specify angle units? How? i.e., are these strings or astropy units?
Contributor guide
No contributing guide indexed for this repository
Research direction
Start with the docstring in pyvo/dal/sia2.py at lines 33-42 and determine how CIRCLE and RANGE arguments specify angle units. Confirm the intended default and whether units are strings or Astropy units, then update the documentation so both cases are unambiguous.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100