[skip changelog] Make the command documentation of cache clean more clear #1135
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.
The terms "cache" and "clean" might bring compilation to mind, but the
arduino-cli cache cleancommand has nothing todo with compilation. Many users will likely not even be aware of the existence or purpose of the
directories.downloadsfolder. For this reason, it's important to make the purpose of this command clear.
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)docs update
The terms "cache" and "clean" might bring compilation to mind, but the
arduino-cli cache cleancommand has nothing todo with compilation. Many users will likely not even be aware of the existence or purpose of the
directories.downloadsfolder. It's not very clear from the command documentation for
arduino-cli cache cleanwhat it does.For example:
#969 (comment)
The purpose of the
arduino-cli cache cleanis more clearly described in the command line documentation.titled accordingly?
No
See how to contribute