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

Jump to bottom

Fix missing parameter in transfer_complete_datasets() docstring #273

Merged
merged 3 commits into from
Jun 28, 2023
Merged

Fix missing parameter in transfer_complete_datasets() docstring #273

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
eb19cb4
Add path parameter to `transfer_complete_datasets()` docstring
SolarDrew Jun 28, 2023
0750d56
Add changelog
SolarDrew Jun 28, 2023
e0d8873
Merge branch 'main' into bugfix-231
Cadair Jun 28, 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
1 change: 1 addition & 0 deletions changelog/273.bugfix.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Update docstring for `transfer_complete_datasets()` to include previously missing `path` parameter.
10 changes: 10 additions & 0 deletions dkist/net/helpers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,16 @@ def transfer_complete_datasets(datasets: Union[str, Iterable[str], QueryResponse
can be a table or a row from the search results returned by a call to
``Fido.search``.

path
The path to save the data in, must be accessible by the Globus
endpoint.
The default value is ``/~/``.
It is possible to put placeholder strings in the path with any key
from the dataset inventory dictionary which can be accessed as
``ds.meta['inventory']``. An example of this would be
``path="~/dkist/{datasetId}"`` to save the files in a folder named
with the dataset ID being downloaded.

destination_endpoint
A unique specifier for a Globus endpoint. If `None` a local
endpoint will be used if it can be found, otherwise an error will
Expand Down