clarify SLURM job handler docs (#5748)

* clarify SLURM job handler docs * Update cylc/flow/job_runner_handlers/slurm.py Co-authored-by: Oliver Sanders <[email protected]> --------- Co-authored-by: Oliver Sanders <[email protected]>
cylc · Oct 11, 2023 · 522dc98 · 522dc98
1 parent d02d66c
commit 522dc98
Showing 1 changed file with 5 additions and 2 deletions.
diff --git 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: