Skip to content

Commit ef60977

Browse files
committed
clarified how versions work in docstrings
1 parent db854eb commit ef60977

1 file changed

Lines changed: 7 additions & 2 deletions

File tree

synapseclient/models/download_list.py

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -592,7 +592,9 @@ async def add_files_async(
592592
*,
593593
synapse_client: Optional["Synapse"] = None,
594594
) -> int:
595-
"""Add specific file versions to the Synapse download list.
595+
"""
596+
Add files to the Synapse download list.
597+
If a file is added with no version specified, the latest version will be downloaded.
596598
597599
Arguments:
598600
files: List of DownloadListItem objects identifying the file
@@ -615,7 +617,10 @@ async def remove_files_async(
615617
*,
616618
synapse_client: Optional["Synapse"] = None,
617619
) -> int:
618-
"""Remove specific file versions from the Synapse download list.
620+
"""
621+
Remove files from the Synapse download list.
622+
If a file was added with a version specified, then that version must be specified to remove it.
623+
If a file was added with no version specified, then no version must be specified to remove it.
619624
620625
Arguments:
621626
files: List of DownloadListItem objects identifying the file versions to remove.

0 commit comments

Comments
 (0)