Correct message re: enabling logging #859
Merged
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)
What kind of change does this PR introduce?
Bug fix
What is the current behavior?
If the
v
key is not set totrue
in the configuration file, Arduino Create Agent prints a seemingly helpful message to the terminal:However, it is not helpful after all because there is no
-v
command line flag. The sole mechanism for controlling logging is thev
key of the configuration file. If the user follows the instructions they will get an error:What is the new behavior?
Change the message to specify the use of the configuration file instead of a non-existent flag.
Does this PR introduce a breaking change?
No
Other information
An alternative solution would be to implement the mythical
-v
flag. However, I don't think there is a need for such a flag.The end users don't have any need to run Arduino Create Agent from the command line under normal usage, and when they are running it from the command line it is likely to be during troubleshooting, when logging will be useful. Since logging is enabled by default, it will be rare that a user would have the need to change the logging behavior.