Skip to content

Commit 864fdc3

Browse files
committed
DOC: Clarify tarball session handling
Make explicit that the --dicom_dir_template argument will assign each tarball to a separate session and ignore the --ses flag if multiple are found
1 parent bad781a commit 864fdc3

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

heudiconv/cli/run.py

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -140,8 +140,11 @@ def get_parser():
140140
'(can be compressed) are supported in addition to '
141141
'directory. All matching tarballs for a subject are '
142142
'extracted and their content processed in a single '
143-
'pass. Note that you might need to surround the value '
144-
'with quotes to avoid {...} being considered by shell')
143+
'pass. If multiple tarballs are found, each is '
144+
'assumed to be a separate session and the --ses '
145+
'argument is ignored. Note that you might need to '
146+
'surround the value with quotes to avoid {...} being '
147+
'considered by shell')
145148
group.add_argument('--files', nargs='*',
146149
help='Files (tarballs, dicoms) or directories '
147150
'containing files to process. Cannot be provided if '

0 commit comments

Comments
 (0)