Skip to content

Commit 63177d8

Browse files
committed
revise docstring to omit impl specific naming of _download
1 parent 31b3cb6 commit 63177d8

1 file changed

Lines changed: 3 additions & 2 deletions

File tree

irods/manager/data_object_manager.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -287,8 +287,9 @@ def get(
287287
replica_sort_function: a sort key function dictating the order of replica query results in 'self.replicas'.
288288
If not specified, a default value of None will cause irods.data_objects._DEFAULT_SORT_KEY_FN to be
289289
selected to determine the sort order.
290-
**options: keyword arguments to be passed onto the _download function; A combination of possible options
291-
to be relayed to the iRODS data object open() call.
290+
**options: a combination of possible iRODS keyword options to be relayed to the data object open() call.
291+
For a download request, FORCE_FLAG_KW may be used to ensure any pre-existing file at the 'local_path'
292+
will be overwritten.
292293
293294
Returns:
294295
an iRODSDataObject representing the object at the given path.

0 commit comments

Comments
 (0)