Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation for SIA2: How are units supposed to be specified? #593

Open
keflavich opened this issue Sep 7, 2024 · 1 comment
Open

Comments

@keflavich
Copy link
Contributor

pyvo/pyvo/dal/sia2.py

Lines 33 to 42 in 4a6f52f

SIA2_PARAMETERS_DESC = """
pos : single or list of tuples
angle units (default: deg)
the positional region(s) to be searched for data. Each region can
be expressed as a tuple representing a CIRCLE, RANGE or POLYGON as
follows:
(ra, dec, radius) - for CIRCLE. (angle units - defaults to)
(long1, long2, lat1, lat2) - for RANGE (angle units required)
(ra, dec, ra, dec, ra, dec ... ) ra/dec points for POLYGON all
in angle units

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?

@bsipocz
Copy link
Member

bsipocz commented Sep 7, 2024

+1 for fixing the docstrings.

you should be able to feed in an astropy angle, and skycoords, if not, then those are bugs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants