jaegertracing / documentation

Documentation/website for the Jaeger Distributed Tracing project.
https://jaegertracing.io/
Apache License 2.0
65 stars 158 forks source link

Add Spell Checker to CI #668

Closed h4shk4t closed 5 months ago

h4shk4t commented 7 months ago

Which problem is this PR solving?

Description of the changes

netlify[bot] commented 7 months ago

Deploy Preview for romantic-neumann-1959d7 ready!

Name Link
Latest commit 64e4bd4e1fac5d0f21b273ce6607488ad68dfc33
Latest deploy log https://app.netlify.com/sites/romantic-neumann-1959d7/deploys/660f1d001d0b7d0008674460
Deploy Preview https://deploy-preview-668--romantic-neumann-1959d7.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

yurishkuro commented 6 months ago

The spellchecker flags normal words, so I don't see it as a viable solution at this point. Maybe it needs better dictionaries. Also, I would argue it should not be checking test formatted as code, because that will always bring a lot of noise.

h4shk4t commented 6 months ago

@yurishkuro I did some digging and found the latest dictionary by aspell from 2020 in one of their mirrors. It shows some improvement where it is not flagging words like mentorship, analytics and more (verified this manually). However there are still a lot more common words which are still being flagged like roadmap and onboarding. I was trying Hunspell again, but I am facing issues with making it ignore hexadecimal values (will try to look for some bypasses to fix this issue in the meantime). Kindly advise if I should continue with aspell with a custom dictionary which also includes words like roadmap and onboarding, or to try and make Hunspell reduce false positives from code blocks and hexadecimal values.

yurishkuro commented 6 months ago

@h4shk4t I don't have preference in the tool, I only have preference for the end result - low friction :-)

h4shk4t commented 6 months ago

@yurishkuro Made the changes. Using cspell binary for spellchecking. Gives a promising accuracy and far lesser tolerance for false positives. Kindly let me know if this suffices.

Best Regards

yurishkuro commented 6 months ago

The lint step is catching some real misspellings now, plus a few words that need to go to the dictionary

h4shk4t commented 5 months ago

The lint step is catching some real misspellings now, plus a few words that need to go to the dictionary

Yes, I will add the new words to the dictionary (must have missed them earlier). What should I do about the misspellings?