From 5d01067eb16e32fc76cd340e4bb932e82bbff5d0 Mon Sep 17 00:00:00 2001 From: Oliver Sanders Date: Thu, 15 Feb 2024 17:38:52 +0000 Subject: [PATCH] option parsers: fix "-z" option help text (#5970) --- cylc/flow/option_parsers.py | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/cylc/flow/option_parsers.py b/cylc/flow/option_parsers.py index ab5f1fcbf91..5f6828134ee 100644 --- a/cylc/flow/option_parsers.py +++ b/cylc/flow/option_parsers.py @@ -421,12 +421,13 @@ class CylcOptionParser(OptionParser): ['-z', '--set-list', '--template-list'], metavar='NAME=VALUE1,VALUE2,...', help=( - 'Set the value of a Jinja2 template variable in the' - ' workflow definition as a comma separated' - ' list of Python strings.' - ' Values containing commas must be quoted.' - " e.g. '+s STR=a,b,c' => ['a', 'b', 'c']" - " or '+ s STR=a,\"b,c\"' => ['a', 'b,c']" + 'A more convenient alternative to --set for defining a list' + ' of strings. E.G.' + ' "-z FOO=a,b,c" is shorthand for' + ' "-s FOO=[\'a\',\'b\',\'c\']".' + ' Commas can be present in values if quoted, e.g.' + ' "-z FOO=a,\'b,c\'" is shorthand for' + ' "-s FOO=[\'a\',\'b,c\']".' + CAN_BE_USED_MULTIPLE + NOTE_PERSIST_ACROSS_RESTARTS ),