-
Notifications
You must be signed in to change notification settings - Fork 1.6k
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
Spell checking #2508
Comments
Please make this opt-in. The "Add backticks here" lint is already annoying enough. |
I think that once this lint works properly it should be opt-out, but in any case some lints being annoying to some people is something that should be solved by #1313 |
Spell checking is hard. Especially with identifiers. If I turn on a spell checker on my code I get squiggly lines everywhere for stuff like |
@oli-obk I think one should start with spell checking documentation comments. If a word is incorrectly typed in a comment, we can then check whether its an identifier in the code, and not emit a diagnostic. But spelling errors in documentation comments are annoying. Spell checking identifiers should be done with great care, and probably will remain opt-in forever. Some people prefer |
Well we can skip text in backticks. And since one should be placing identifiers in backticks, they aren't linted in doc comments. |
I think that spelling isn't a huge issue considering how variable typos are compile errors, rather than runtime errors. Sure, I'd have loved this for the times when I was developing in PHP and didn't notice the difference between For docs, it might be useful, but it should ignore items in backticks. |
It would be nice if clippy could be able to spell-check comments, identifiers, ...
Previous work here: https://github.com/huonw/spellck
The text was updated successfully, but these errors were encountered: