fix: converted help strings to single line strings

snakemake · Jan 2, 2025 · 829a889 · 829a889
1 parent 63b4f59
commit 829a889
Showing 1 changed file with 19 additions and 29 deletions.
diff --git a/snakemake_executor_plugin_slurm/__init__.py b/snakemake_executor_plugin_slurm/__init__.py
@@ -36,61 +36,51 @@ class ExecutorSettings(ExecutorSettingsBase):
     logdir: Optional[str] = field(
         default=os.path.join(os.path.expanduser("~"), ".snakemake", "slurm_logs"),
         metadata={
-            "help": """
-                   Per default the SLURM log directory (writing output is
-                   required by SLURM) is '~/.snakemake/slurm_logs'.
-                   This flag allows to set an alternative directory.
-                   """,
+            "help": "Per default the SLURM log directory (writing output is "
+            "required by SLURM) is '~/.snakemake/slurm_logs'. "
+            "This flag allows to set an alternative directory. ",
             "env_var": False,
             "required": False,
         },
     )
     keep_successful_logs: bool = field(
         default=False,
         metadata={
-            "help": """
-                   Per default SLURM log files will be deleted upon sucessful
-                   completion of a job. Whenever a SLURM job fails, its log
-                   file will be preserved.
-                   This flag allows to keep all SLURM log files, even those
-                   of successful jobs.
-                   """,
+            "help": "Per default SLURM log files will be deleted upon sucessful "
+            "completion of a job. Whenever a SLURM job fails, its log "
+            "file will be preserved. "
+            "This flag allows to keep all SLURM log files, even those "
+            "of successful jobs.",
             "env_var": False,
             "required": False,
         },
     )
     delete_logfiles_older_than: Optional[int] = field(
         default=10,
         metadata={
-            "help": """
-                Per default SLURM log files in the SLURM log directory
-                of a workflow will be deleted after 10 days. For this,
-                best leave the default log directory unaltered.
-                Setting this flag allows to change this behaviour.
-                If set to <=0, no old files will be deleted.
-                """
+            "help": "Per default SLURM log files in the SLURM log directory "
+            "of a workflow will be deleted after 10 days. For this, "
+            "best leave the default log directory unaltered. "
+            "Setting this flag allows to change this behaviour. "
+            "If set to <=0, no old files will be deleted. ",
         },
     )
     init_seconds_before_status_checks: Optional[int] = field(
         default=40,
         metadata={
-            "help": """
-                Defines the time in seconds before the first status
-                check is performed after job submission.
-                """,
+            "help": "Defines the time in seconds before the first status "
+            "check is performed after job submission.",
             "env_var": False,
             "required": False,
         },
     )
     requeue: bool = field(
         default=False,
         metadata={
-            "help": """
-                    Allow requeuing preempted of failed jobs,
-                    if no cluster default. Results in
-                    `sbatch ... --requeue ...`
-                    This flag has no effect, if not set.
-                    """,
+            "help": "Allow requeuing preempted of failed jobs, "
+            "if no cluster default. Results in "
+            "`sbatch ... --requeue ...` "
+            "This flag has no effect, if not set.",
             "env_var": False,
             "required": False,
         },