docs: clarify clean: true and default include
#387
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
agilgur5
added
scope: docs
- the docs for `clean` don't seem to have been updated with f15cb84, which slightly changed how it works - also clarify that "wipes out cache" means it deletes _all_ previous caches by saying "wipes any existing cache" instead - fix the `include` default explanation to mention `.tsx` files as well, since the regex includes those - also add code backticks and capitalize TypeScript etc (guess I missed this option in my previous PRs? or I intentionally left it as a separate change a while ago...) - also add code backticks around `node_modules` in `cacheRoot` as well while at it - use non-rendered newlines between sentences for markdown style consistency
agilgur5
force-pushed
the
docs-clarify-clean
branch
from
f58154d to
d333709
Compare
Collaborator
Author
|
Windows CI failures are due to #385 |
agilgur5
added
kind: dx
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
Minor docs clarifications, fixes, and style consistency
Details
the docs for
cleandon't seem to have been updated after f15cb84 (Don't create cache dir whenclean: true#68), which slightly changed how it worksalso clarify that "wipes out cache" means it deletes all previous caches by saying "wipes any existing cache" instead
fix the
includedefault explanation to mention.tsxfiles as well, since the regex includes thosealso add code backticks around
node_modulesincacheRootas well while at ituse non-rendered newlines between sentences for markdown style consistency