[skip changelog] Remove spurious argument from error message #1827
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
`github.com/arduino/arduino-cli/i18n.Tr` provides a `fmt.Printf`-style interface, where the first argument may serve as a template filled by subsequent arguments according to its format verbs. This call contains a subsequent argument, but no verb in the format string to use it. This generates some cryptic content in the error message. For example: Error during install: Error downloading tool arduino:[email protected]: no versions available for the current OS%!(EXTRA *cores.ToolRelease=arduino:[email protected]) The tool name is already provided in the correctly configured `Message` field of the error, so there is no need to include it in the `Cause` field as well, so the spurious argument can be removed entirely rather than the alternative fix of adjusting the format string argument. I suspect the spurious argument was simply the result of a copy/paste error.
per1234
added
topic: code
Codecov Report
@@ Coverage Diff @@
## master #1827 +/- ##
=======================================
Coverage 35.86% 35.86%
=======================================
Files 231 231
Lines 19324 19324
=======================================
Hits 6930 6930
Misses 11569 11569
Partials 825 825
Flags with carried forward coverage won't be shown. Click here to find out more.
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
cmaglie
approved these changes
Aug 9, 2022
|
I think that there is a way to let golint to detect this kind of errors (i.e. tell the linter that |
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.
Please check if the PR fulfills these requirements
before creating one)
our contributing guidelines
UPGRADING.mdhas been updated with a migration guide (for breaking changes)What kind of change does this PR introduce?
Bug fix
What is the current behavior?
github.com/arduino/arduino-cli/i18n.Trprovides afmt.Printf-style interface, where the first argument may serve as a template filled by subsequent arguments according to its format verbs.The call modified in this PR contains a subsequent argument, but no verb in the format string to use it. This generates some cryptic content in the error message.
For example:
(note the unexpected
%!(EXTRA *cores.ToolRelease=arduino:[email protected]))What is the new behavior?
The cryptic content is not present in the error message:
For example:
The tool name is already provided in the correctly configured
Messagefield of the error, so there is no need to include it in theCausefield as well, so the spurious argument can be removed entirely rather than the alternative fix of adjusting the format string argument. I suspect the spurious argument was simply the result of a copy/paste error.Does this PR introduce a breaking change?
No breaking change