cylc-flow icon indicating copy to clipboard operation
cylc-flow copied to clipboard

VIP/VR Standard options don't say which steps they apply to

Open wxtim opened this issue 1 year ago • 0 comments

Description

Options added to VIP and VR from option_parsers.CylcOptionParser.STD_OPTIONS include items such as -s which don't apply to cylc install, but to do apply to validate and play. This is not reflected in the help docs:

Reproducible Example

> cylc vip --help
# States which steps item is valid for
-O OPT_CONF_KEYS, --opt-conf-key=OPT_CONF_KEYS
                        [validate, install] Use optional Rose Config Setting

...
# Does not state which step item is valid for
-s NAME=VALUE, --set=NAME=VALUE
                        Set the value of a Jinja2 template variable in the

# but if we assume it applies to all steps:
cylc install /var/tmp/cylc-src/like.rail --set 'HELLO="hi"'
...
cylc: error: no such option: --set

Expected Behaviour

All items should have labels for compound commands listing which steps they apply to.

wxtim avatar Jul 12 '24 09:07 wxtim