fix: repair --format help text in CLI - #785
Open
Socialpranker wants to merge 1 commit into
Open
Conversation
The continuation of the --format value list was printed after the
--forgiving line, so the help output broke the description in half:
--format Convert to a specific format. Must be one of: vcard, vcard21,
--forgiving Makes the parser less strict.
vcard30, vcard40, icalendar20, jcal, jcard, json, mimedir.
Move the continuation back under --format, and add the missing
'icalendar' value: the match in the 'format' case accepts ten values,
the help text listed nine.
This file contains hidden or 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
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.
Disclosure: this patch was prepared with AI assistance (Claude Opus 5). I checked the
matcharms and traced the print order inshowHelp()myself before opening this.Problem
Two things are off in the
--formatentry ofvobject --help.The description is split in half by another option.
showHelp()prints line by line, and the continuation of the format list sits after the--forgivingline, so the actual output reads:One accepted value is missing. The
formatcase inparseArguments()accepts ten values:The help text lists nine —
icalendar(without the20suffix) is absent, even though--format=icalendarworks.Fix
Move the continuation lines back under
--formatand addicalendar. The list now needs three lines to stay inside the same width as the surrounding entries, so it wraps ontomimedir.rather than being crammed in.Resulting output:
Help text only — no behaviour change.