chore: fix incorrect command-line args in the README #51
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ddneilson
force-pushed
the
ddneilson/fix_readme_args
branch
from
ef753e4 to
5983fee
Compare
gahyusuh
reviewed
Feb 21, 2024
| |`--environment`|paths|no| Path to a file containing Environment Template definitions. Can be provided multiple times. |`--environment /path/to/env.template1.json --environment /path/to/env.template2.yaml`| | ||
| |`--job-param`, `-p`|string, path|no| The values for the job template's parameters. Can be provided as key-value pairs, inline JSON string, or as path(s) to a JSON or YAML document. If provided more than once then the given values are combined in the order that they appear. |`--job-param MyParam=5`, `-p file://parameter_file.json`, `-p '{"MyParam": "5"}'`| | ||
| |`--task-params`, `-tp`|string|no| Instructs the command to run a single task in a Session with the given value for one of the task parameters. The option must be provided once for each task parameter defined for the Step, with each instance providing the value for a different task parameter. Mutually exclusive with `--tasks` and `--maximum-tasks`. |`-tp MyParam=5 -tp MyOtherParam=Foo`| | ||
| |`--task-param`, `-tp`|string|no| Instructs the command to run a single task in a Session with the given value for one of the task parameters. The option must be provided once for each task parameter defined for the Step, with each instance providing the value for a different task parameter. Mutually exclusive with `--tasks` and `--maximum-tasks`. |`-tp MyParam=5 -tp MyOtherParam=Foo`| |
There was a problem hiding this comment.
I can see --task-params in the Example section, and Description for the --maximum-tasks argument (in the table). I wonder if these should also be updated?
There was a problem hiding this comment.
Good eye. Oversight on my part!
epmog
previously approved these changes
Feb 21, 2024
The README is showing out-of-date command-line arguments that reflect a previous version of the CLI. This updates the contents of the README. Signed-off-by: Daniel Neilson <[email protected]>
ddneilson
force-pushed
the
ddneilson/fix_readme_args
branch
from
5983fee to
83d1bb9
Compare
gahyusuh
approved these changes
Feb 21, 2024
epmog
approved these changes
Feb 21, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What was the problem/requirement? (What/Why)
The README is showing out-of-date command-line arguments that reflect a previous version of the CLI..
What was the solution? (How)
I've updated the README by comparing its contents against:
openjd check --helpopenjd summary --helpopenjd run --helpopenjd schema --helpWhat is the impact of this change?
Anyone using the README for documentation will not be misled.
How was this change tested?
N/A
Was this change documented?
It is documentation.
Is this a breaking change?
No.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.