Explain JSON input in help text #4490
Merged
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
Some input format options must be used alongside --json-in to indicate what kind of JSON it is. Tell the user this.
adamnovak
approved these changes
Jan 13, 2025
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.
Some input format options must be used alongside
--json-into indicate what kind of JSON it is. Tell the user this.Changelog Entry
To be copied to the draft changelog by merger:
vg viewDescription
If you want to e.g. convert the JSON version of a GAM to a regular GAM, you have to use both
--json-inand--align-in. However, the current help text appears to say that--align-inis only for GAM format. This edit makes clear that it for JSON versions of GAMs, not just vanilla GAMs.