Skip to content

Commit 4b0c754

Browse files
committed
fix docs
1 parent c2f5f90 commit 4b0c754

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

docs/alma/alma.rst

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -181,21 +181,23 @@ or if you wanted all projects by a given PI:
181181
Querying For Proprietary Data
182182
-----------------------------
183183
184-
To query for proprietary data (non-public data), you need to first authenticate using the ``login`` method,
185-
and then set ``public=False`` in your query:
184+
To query for proprietary (non-public) data, set ``public=False`` or ``public=None``.
185+
If you want to download the products, you need to first authenticate using the ``login`` method.
186186
187187
.. doctest-skip::
188188
189189
>>> from astroquery.alma import Alma
190190
>>> alma = Alma()
191191
>>> # First login to access proprietary data
192192
>>> alma.login("username") # Will prompt for password
193-
>>> # Now query including proprietary data
194-
>>> proprietary_data = alma.query(payload=dict(project_code='2017.1.01355.L', public=False))
195-
>>> # Or restrict to only proprietary data
193+
>>> # include both public and proprietary data using public=None
194+
>>> proprietary_data = alma.query(payload=dict(project_code='2017.1.01355.L', public=None))
195+
>>> # restrict to only proprietary data with public=False
196196
>>> only_proprietary = alma.query_region('W51', radius=25*u.arcmin, public=False)
197197
198-
When you set ``public=False``, the query will include only proprietary data by adding a condition equivalent to ``data_rights='Proprietary'`` in the underlying SQL query.
198+
Setting ``public=False`` will include only proprietary data, while
199+
``public=None`` will include both public and proprietary data.
200+
199201
200202
The ``query_sia`` method offers another way to query ALMA using the IVOA SIA
201203
subset of keywords returning results in 'ObsCore' format. For example,

0 commit comments

Comments
 (0)