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.

Sign up for GitHub

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

DOC: fix DatalinkResults example #475

Merged
merged 2 commits into from
Sep 6, 2023
Merged

DOC: fix DatalinkResults example #475

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4fa1bc5
DOC: fix DatalinkResults example
bsipocz Aug 9, 2023
98954ca
DOC: remove runid
bsipocz Sep 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions docs/dal/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -802,11 +802,13 @@ identifying the dataset you want it to return.
Since the creation of datalink objects requires a network roundtrip, it is
recommended to call ``getdatalink`` only once.

Of course one can also build a datalink object from it's url.
Of course one can also build a datalink object from its url.

.. TODO: define DatalinkResults
.. doctest-skip::
.. doctest-remote-data::

>>> from pyvo.dal.adhoc import DatalinkResults
>>> # In this example you know the URL from somewhere
>>> url = 'https://ws.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/caom2ops/datalink?runid=m4b2g3aos0fwmtmg&ID=ivo%3A%2F%2Fcadc.nrc.ca%2FHSTHLA%3Fhst_12477_28_acs_wfc_f606w_01%2Fhst_12477_28_acs_wfc_f606w_01_drz'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The runid parameter is not necessary here. It's used internally at the CADC to capture a session information which is not the case here.

>>> datalink = DatalinkResults.from_result_url(url)

Server-side processing
Expand Down