Skip to content

Commit dc9e0f7

Browse files
committed
explain defaults
1 parent a2d8715 commit dc9e0f7

1 file changed

Lines changed: 6 additions & 3 deletions

File tree

irods/manager/data_object_manager.py

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -274,12 +274,15 @@ def get(self,
274274
local_path: a filename within the local filesystem, the target for download ("GET") of the data
275275
object if one is requested. Directory components in the path must already exist.
276276
num_threads: in the case of a parallel data transfer (for large files), specifies how many transfer
277-
control threads should be used.
277+
control threads should be used. If not specified, a reasonable default is chosen.
278278
updatables: a tuple or list in which each element is a tqdm-like progress bar object, or the equivalent:
279279
an instance on which func.update(n) can be called with n being the number of bytes successfully
280280
copied in the the data transfer increment just completed. If not a tuple or list, this argument
281-
is interpreted as a single updatable.
282-
replica_sort_function: a sort key function dictating the order of replica query results in 'self.replicas'
281+
is interpreted as a single updatable. The parameter defaults to (), meaning no such objects will be
282+
slated for update.
283+
replica_sort_function: a sort key function dictating the order of replica query results in 'self.replicas'.
284+
If not specified, a default value of None will cause irods.data_objects._DEFAULT_SORT_KEY_FN to be
285+
selected to determine the sort order.
283286
**options: keyword arguments to be passed onto the _download function; A combination of possible options
284287
to be relayed to the iRODS data object open() call.
285288

0 commit comments

Comments
 (0)