Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
wxtim opened this issue Jul 12, 2024 · 0 comments
Open

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

wxtim opened this issue Jul 12, 2024 · 0 comments
Labels
could be better Not exactly a bug, but not ideal.
Milestone

Comments

@wxtim
Copy link
Member

wxtim commented Jul 12, 2024

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 wxtim added the bug Something is wrong :( label Jul 12, 2024
@wxtim wxtim added this to the some-day milestone Jul 12, 2024
@wxtim wxtim added could be better Not exactly a bug, but not ideal. and removed bug Something is wrong :( labels Jul 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
could be better Not exactly a bug, but not ideal.
Projects
None yet
Development

No branches or pull requests

1 participant