Skip to content
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

Docs: remove outdated note about caching only valid files (fixes #10739) #10740

Closed
wants to merge 1 commit into from

Conversation

ajafff
Copy link
Contributor

@ajafff ajafff commented Aug 6, 2018

What is the purpose of this pull request? (put an "X" next to item)

[x] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofixing to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:

What changes did you make? (Give an overview)
Remove outdated paragraph.

Is there anything you'd like reviewers to focus on?

@eslint-deprecated eslint-deprecated bot added the triage An ESLint team member will look at this issue soon label Aug 6, 2018
@platinumazure platinumazure added documentation Relates to ESLint's documentation core Relates to ESLint's core APIs and features accepted There is consensus among the team that this change meets the criteria for inclusion and removed triage An ESLint team member will look at this issue soon labels Aug 6, 2018
@platinumazure
Copy link
Member

I think this is probably okay as is, but I'll note that if a file is autofixed, it will not be stored in the cache (or rather, the changing of the file as part of autofix will invalidate the cache entry). So it would need to be linted one more time, and then it would be in the cache.

That said-- not sure that is an important note, so this is probably fine as it is.

@kaicataldo
Copy link
Member

I'm all for more documentation in this case so that it's easy to understand what it does both for users and for future maintainers (us!).

Copy link
Member

@platinumazure platinumazure left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can just change the note to say that files that are autofixed are not put in the cache (the implication being, everything else will be put in the cache).

What do you think?

@kaicataldo
Copy link
Member

@ajafff Friendly ping!

@platinumazure
Copy link
Member

@ajafff Friendly ping: Are you able to finish this? Let us know if we can help!

@zacnomore
Copy link
Contributor

I'd like to take this over if that's alright. It's been a number of weeks at this point.

@zacnomore
Copy link
Contributor

Added PR: #10913

@platinumazure
Copy link
Member

Closing as #10913 was merged to resolve the original issue. Thanks for contributing regardless, we really appreciate it!

@eslint-deprecated eslint-deprecated bot locked and limited conversation to collaborators Apr 7, 2019
@eslint-deprecated eslint-deprecated bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Apr 7, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion archived due to age This issue has been archived; please open a new issue for any further discussion core Relates to ESLint's core APIs and features documentation Relates to ESLint's documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants