Merge pull request #488 from BitForge95/fix-pad-option-help

Improve explanation of pad option in CLI help

Author: smoia

phys2bids/cli/run.py

@@ -1,7 +1,6 @@
 # -*- coding: utf-8 -*-
 """Parser for phys2bids."""
 
-
 import argparse
 
 from phys2bids import __version__
@@ -36,15 +35,15 @@ def _get_parser():
         "--info",
         dest="info",
         action="store_true",
-        help="Only output info about the file, don't process. " "Default is to process.",
+        help="Only output info about the file, don't process. Default is to process.",
         default=False,
     )
     optional.add_argument(
         "-indir",
         "--input-dir",
         dest="indir",
         type=str,
-        help="Folder containing input. " "Default is current folder.",
+        help="Folder containing input. Default is current folder.",
         default=".",
     )
     optional.add_argument(
@@ -77,15 +76,15 @@ def _get_parser():
         "--subject",
         dest="sub",
         type=str,
-        help='Specify alongside "-heur". Code of ' "subject to process.",
+        help='Specify alongside "-heur". Code of subject to process.',
         default=None,
     )
     optional.add_argument(
         "-ses",
         "--session",
         dest="ses",
         type=str,
-        help='Specify alongside "-heur". Code of ' "session to process.",
+        help='Specify alongside "-heur". Code of session to process.',
         default=None,
     )
     optional.add_argument(
@@ -151,9 +150,9 @@ def _get_parser():
         "--padding",
         dest="pad",
         type=float,
-        help="Padding in seconds used around a single run "
-        "when separating multi-run session files. "
-        "Default is 9 seconds.",
+        help="Amount of seconds of recording that is saved around the real take, "
+        "both before and after it. At the moment it should be less than the "
+        "time between two takes. Default is 9 seconds.",
         default=9,
     )
     optional.add_argument(
@@ -170,7 +169,7 @@ def _get_parser():
         "--participant-yml",
         dest="yml",
         type=str,
-        help="full path to file with info needed to generate " "participant.tsv file ",
+        help="full path to file with info needed to generate participant.tsv file ",
         default="",
     )
     optional.add_argument(