Skip to content

Commit 1cf7862

Browse files
committed
DOC: Quote {subject} in example usage and provide a note in description
1 parent 02f5980 commit 1cf7862

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

heudiconv/cli/run.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ def main(argv=None):
130130

131131
def get_parser():
132132
docstr = ("""Example:
133-
heudiconv -d rawdata/{subject} -o . -f heuristic.py -s s1 s2 s3""")
133+
heudiconv -d 'rawdata/{subject}' -o . -f heuristic.py -s s1 s2 s3""")
134134
parser = ArgumentParser(description=docstr)
135135
parser.add_argument('--version', action='version', version=__version__)
136136
group = parser.add_mutually_exclusive_group()
@@ -139,7 +139,9 @@ def get_parser():
139139
'subject id {subject} and session {session}. Tarballs '
140140
'(can be compressed) are supported in addition to '
141141
'directory. All matching tarballs for a subject are '
142-
'extracted and their content processed in a single pass')
142+
'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')
143145
group.add_argument('--files', nargs='*',
144146
help='Files (tarballs, dicoms) or directories '
145147
'containing files to process. Cannot be provided if '

0 commit comments

Comments
 (0)