search

cylc / cylc-flow

Cylc: a workflow engine for cycling systems.
https://cylc.github.io
GNU General Public License v3.0
335 stars 94 forks source link

CLI: VIP and VR should accurately report options for components #5383

Open wxtim opened 1 year ago

wxtim commented 1 year ago

Problem

The current VIP and VR scripts tell users what atomic scripts would be being called. That is, 

cylc vip /loc/myworkflow --workflow-name foo -s='BAZ=42'
...
$ cylc validate /loc/myworkflow
...
$ cylc install /loc/myworkflow
...
$ cylc play foo -s='BAZ=42'

These reports should also include a full list of options relevant to that command, as is effectively done for Cylc Play in https://github.com/cylc/cylc-flow/pull/5377:

That is, when called the output should be

...
$ cylc validate /loc/myworkflow -s='BAZ=42'
...
$ cylc install /loc/myworkflow --workflow-name foo
...
$ cylc play foo -s='BAZ=42'
oliver-sanders commented 1 year ago

I did something similar for argparse, easy conversion.

oliver-sanders commented 10 months ago

Don't have the time to push this one through ATM.

Closing this PR: https://github.com/cylc/cylc-flow/pull/5385, but will leave the branch behind.