Skip to content

Increase the CI spell checker efficiency #312

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

Closed
PatKamin opened this issue Mar 8, 2024 · 3 comments · Fixed by #1035
Closed

Increase the CI spell checker efficiency #312

PatKamin opened this issue Mar 8, 2024 · 3 comments · Fixed by #1035
Labels
enhancement New feature or request

Comments

@PatKamin
Copy link
Contributor

PatKamin commented Mar 8, 2024

Rationale

Currently, 'typos' Github Action is used in CI (spellcheck.yml) to check for typos made. However, it is not ideal and doesn't catch some of rather easy to see typos. See ie. this comment.

Description

Replace typos Github Action with other tool which would increase the efficiency of finding typos. One tool that can be used is codespell on Linux.

API Changes

None

@PatKamin PatKamin added the enhancement New feature or request label Mar 8, 2024
@lukaszstolarczuk
Copy link
Contributor

I believe, the problem with typos (at the moment) is that it does not run on all types of files. Perhaps it just requires a better configuration.

@lukaszstolarczuk
Copy link
Contributor

verified on a few tools, some are not supporting CMake files, some rst files... we should find a good tool to rule them all 😉

@lukaszstolarczuk
Copy link
Contributor

codespell added in #994

next step would be to add a checker for rst files (which seems not covered via either of our tools)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants