Change % to %% when using ${DEFAULT-VALUE} in option description #643
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
Percent signs shall be escaped in the description text as it is going to be passed to String.format. If the default value contains (single) % signs then using the built-in DEFAULT-VALUE variable would lead to a warning message. This is avoided by escaping any % signs in the DEFAULT-VALUE variable when used in the description.
Codecov Report
@@ Coverage Diff @@
## master #643 +/- ##
=========================================
Coverage 97.61% 97.61%
Complexity 363 363
=========================================
Files 4 4
Lines 4569 4569
Branches 1137 1137
=========================================
Hits 4460 4460
Misses 27 27
Partials 82 82
Continue to review full report at Codecov.
|
|
Thank you for the PR! |
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.
Percent signs shall be escaped in the description text as it is going
to be passed to String.format. If the default value contains (single) %
signs then using the built-in DEFAULT-VALUE variable would lead to a
warning message. This is avoided by escaping any % signs in the
DEFAULT-VALUE variable when used in the description.
This is related to #615 and its fix. I have an option with a default value of "%s - page %d of %d" and using ${DEFAULT-VALUE} in the description leads to the warning message. A workaround would have been to not use ${DEFAULT-VALUE} but instead writing the default value with doulbe % signs in the description but I definitely prefer the use of the variable just in case the default changes some time later.