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
Clarify Linter vs ESLint in node.js api docs #14953
Comments
Can you explain what you think is missing or should be clarified? |
A bit from each blurb at the tops of the classes could be bubbled up to the top. Also perhaps a sentence on why having access to the file system is useful. For example. I needed some additional ts configurations that I didn't realize. I was trying to use linter. But when I switched to eslint it worked perfectly. Even just a disclaimer at the top "these classes appear similar but have important differences" let me know what you think |
We have this blurb under the ESLint class header:
Do you think changes should be made there to clarify things? |
I suppose that's exactly my point. Unless you read the header for ESLint, and you just read the header for Linter. You'd miss the fact that they are similar |
Here’s the description for Linter:
What would you change? Would adding a sentence like, “Unless you are working in the browser, you probably want to use the ESLint class instead,” address your concern? |
I do think that would help |
Cool, that’s feasible. Do you want to submit a pull request for that? |
Is this issue open for now? |
I'm on vacation away from a computer until Monday. But I can make a quick PR then |
Perfect, no hurry. |
Well I think I messed up a few things about the title. But I just signed the CLA and hopefully fixed the title #14995 |
Looks good |
The version of ESLint you are using.
latest
The problem you want to solve.
improve clarity in docs here https://eslint.org/docs/developer-guide/nodejs-api#-eslintlintfilespatterns
Your take on the correct solution to problem.
Just add a few sentences clarify the differences between Linter and ESLint objects as they have a lot of overlap
Are you willing to submit a pull request to implement this change?
Yes, but I feel like someone with more domain knowledge would be more successful!
The text was updated successfully, but these errors were encountered: