Skip to content

Commit 398ccca

Browse files
committed
public_data -> public
1 parent 1ba77cc commit 398ccca

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/alma/alma.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ Querying For Proprietary Data
182182
-----------------------------
183183
184184
To query for proprietary data (non-public data), you need to first authenticate using the ``login`` method,
185-
and then set ``public_data=False`` in your query:
185+
and then set ``public=False`` in your query:
186186
187187
.. doctest-skip::
188188
@@ -191,11 +191,11 @@ and then set ``public_data=False`` in your query:
191191
>>> # First login to access proprietary data
192192
>>> alma.login("username") # Will prompt for password
193193
>>> # Now query including proprietary data
194-
>>> proprietary_data = alma.query(payload=dict(project_code='2017.1.01355.L', public_data=False))
194+
>>> proprietary_data = alma.query(payload=dict(project_code='2017.1.01355.L', public=False))
195195
>>> # Or restrict to only proprietary data
196-
>>> only_proprietary = alma.query_region('W51', radius=25*u.arcmin, public_data=False)
196+
>>> only_proprietary = alma.query_region('W51', radius=25*u.arcmin, public=False)
197197
198-
When you set ``public_data=False``, the query will include only proprietary data by adding a condition equivalent to ``data_rights='Proprietary'`` in the underlying SQL query.
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.
199199
200200
The ``query_sia`` method offers another way to query ALMA using the IVOA SIA
201201
subset of keywords returning results in 'ObsCore' format. For example,

0 commit comments

Comments
 (0)