astropy / astropy/astroquery

Alma.query_object() parameter public=False may not behave as in documentation

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

Description

`obs = Alma.query_object('M83', public=False) `
`obs['data_rights']`

The above code will return all of the Proprietary data, while indicating public=True returns all Public data.

This is different than the [documentation](https://astroquery.readthedocs.io/en/latest/alma/alma.html), as in:

For example, if you want to find all projects with a particular PI, you could do:
`rslt = Alma.query_object('W51', pi_name='*Ginsburg*', public=False)
`

Contributor guide

Open the contributing guide

Research direction

Start with the Alma.query_object entry point and compare the M83 reproduction with the public=False example in the linked Alma documentation. Check how public=True and public=False affect the returned data_rights values; done when the implementation and documentation agree, with the behavior covered by an appropriate regression check.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api, data
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 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.