[Issue 1708] Ignore invalid values in setUsageHelpLongOptionsMaxWidth #1712
Conversation
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
fabio-franco
changed the title
Owner
|
Thank you for the contribution! |
remkop
reviewed
Jun 20, 2022
Owner
remkop
left a comment
remkop
left a comment
There was a problem hiding this comment.
I am okay with not throwing the exception but I do think we to log a message when ignoring the user-specified value. Can you take a look?
| } else if (newValue > width() - DEFAULT_USAGE_LONG_OPTIONS_WIDTH) { | ||
| throw new InitializationException("Invalid usage long options max width " + newValue + ". Value must not exceed width(" + width() + ") - " + DEFAULT_USAGE_LONG_OPTIONS_WIDTH); | ||
| if (newValue >= DEFAULT_USAGE_LONG_OPTIONS_WIDTH && newValue <= width() - DEFAULT_USAGE_LONG_OPTIONS_WIDTH) { | ||
| longOptionsMaxWidth = newValue; |
Owner
There was a problem hiding this comment.
I agree with not throwing an exception, but I would like to log an INFO-level trace message that tells the user that we are ignoring the specified value, and why (similar to the message text of the InitializationException).
Contributor
Author
There was a problem hiding this comment.
Sure, it totally makes sense. I will update the branch and send you an update soon.
remkop
added
type: enhancement ✨
type: API 🔌
theme: usagehelp
remkop
added a commit
that referenced
this pull request
Jun 27, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This is a fix proposal for #1708.
The idea is to avoid exception when the screen is too small and just let setUsageHelpLongOptionsMaxWidth set the newValue when valid.