From 522dc98cb4374af663b1e3bbcc4dca97374f9df1 Mon Sep 17 00:00:00 2001 From: Tim Pillinger <26465611+wxtim@users.noreply.github.com> Date: Wed, 11 Oct 2023 10:49:07 +0100 Subject: [PATCH] clarify SLURM job handler docs (#5748) * clarify SLURM job handler docs * Update cylc/flow/job_runner_handlers/slurm.py Co-authored-by: Oliver Sanders --------- Co-authored-by: Oliver Sanders --- cylc/flow/job_runner_handlers/slurm.py | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/cylc/flow/job_runner_handlers/slurm.py b/cylc/flow/job_runner_handlers/slurm.py index 21c50b0a357..4ec6be20471 100644 --- a/cylc/flow/job_runner_handlers/slurm.py +++ b/cylc/flow/job_runner_handlers/slurm.py @@ -40,8 +40,11 @@ .. note:: - Since not all SLURM commands have a short form, cylc requires - the long form directives. + * Cylc requires long form directives (e.g. ``--begin`` not ``-b``). + * Cylc requires an ``=`` even if the directive does not have a value + (e.g. ``--hold=`` not ``--hold``). + * If a directive does not have a value you may use the short form + (e.g. ``-H=``). But the directive must still be suffixed with an ``=``. These are written to the top of the job script like this: