document workdir-user-subdir

dmd · Oct 16, 2024 · abcfcdd · abcfcdd
1 parent 3b12f52
commit abcfcdd
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/micc_fmriprep.py b/micc_fmriprep.py
@@ -297,7 +297,9 @@ def is_dir(dirname):
 
     workdir_group.add_argument(
         "--workdir-user-subdir",
-        help=argparse.SUPPRESS,
+        help="Rather than using /data/fmriprep-workdir/USERNAME, use a subdirectory of that with the supplied name. "
+        "This flag is used by iris-fmriprep to ensure that multiple runs "
+        "of the same subject, but different sessions, do not collide.",
     )
 
     versioning.add_argument(