-
-
Notifications
You must be signed in to change notification settings - Fork 422
[skip changelog] Make the command documentation of cache clean more clear #1135
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
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
...lear The terms "cache" and "clean" might bring compilation to mind, but the `arduino-cli cache clean` command has nothing to do with compilation. Many users will likely not even be aware of the existence or purpose of the `directories.downloads` folder. For this reason, it's important to make the purpose of this command clear.
@per1234
per1234
requested review from
matthijskooijman,
rsora,
silvanocerza and
ubidefeo
January 13, 2021 19:00
silvanocerza
silvanocerza
approved these changes
Jan 14, 2021
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.
The terms "cache" and "clean" might bring compilation to mind, but the
arduino-cli cache clean
command has nothing todo with compilation. Many users will likely not even be aware of the existence or purpose of the
directories.downloads
folder. 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.md
has 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 clean
command has nothing todo with compilation. Many users will likely not even be aware of the existence or purpose of the
directories.downloads
folder. It's not very clear from the command documentation for
arduino-cli cache clean
what it does.For example:
#969 (comment)
The purpose of the
arduino-cli cache clean
is more clearly described in the command line documentation.titled accordingly?
No
See how to contribute