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

Feature request: Improve help text for deadline bundle submit --help #365

Closed
ddneilson opened this issue Jun 24, 2024 · 0 comments · Fixed by #436
Closed

Feature request: Improve help text for deadline bundle submit --help #365

ddneilson opened this issue Jun 24, 2024 · 0 comments · Fixed by #436
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@ddneilson
Copy link
Contributor

Use Case

Imagine a customer is trying to figure out how to provide values for their Job Parameter(s) when using the command deadline bundle submit. They type deadline bundle submit --help and see:

Options:
  -p, --parameter TEXT            Job template parameters

What is the format of "TEXT"?? (turns out that it's -p VarName=VarValue, but there's no way to know that)

Proposed Solution

Improve the help text, and the README for the package. For inspiration, please see the run command in https://github.com/OpenJobDescription/openjd-cli. e.g.

% openjd run --help
...
  --job-param KEY=VALUE, file://PATH_TO_PARAMS, '{"KEY": "VALUE", ... }', -p KEY=VALUE, file://PATH_TO_PARAMS, '{"KEY": "VALUE", ... }'
                        Use these Job parameters with the provided template. Can be provided as key-value pairs, path(s) to a JSON or YAML document prefixed with
                        'file://', or inline JSON. If this option is provided more than once then the given values are all combined in the order that they appear.
@ddneilson ddneilson added good first issue Good for newcomers documentation Improvements or additions to documentation labels Jun 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant