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

Enable codespell to automatically check for spelling mistakes #505

Open
aloisklink opened this issue Mar 13, 2023 · 0 comments
Open

Enable codespell to automatically check for spelling mistakes #505

aloisklink opened this issue Mar 13, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@aloisklink
Copy link
Contributor

Is your feature request related to a problem? Please describe.

We're occasionally making typos in the edgesec documentation. Having an automated spellchecker would help fix this.

Discussed in #504 (comment)

Describe the solution you'd like

It may be worth enabling something like codespell. It easily integrates with `pre-commit, so it should be pretty easy to run. The only issue is fixing all the false positives.

Describe alternatives you've considered

cspell is pretty popular in the Node.JS eco-system. However, because it requires Node.JS (which is pretty massive), it's not a great fit for our project.

codespell uses Python, which is already something we need, due to our dependency on pre-commit.

Additional context

It may not be worth enabling, as it may cause a bunch of false positives. Another thing that might help is enabling Doxygen warnings, since I'm sure that some of our docs might not be rendering properly.

@aloisklink aloisklink added the documentation Improvements or additions to documentation label Mar 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant