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

Automated spell checking #1675

Open
ehuss opened this issue Nov 14, 2024 · 1 comment
Open

Automated spell checking #1675

ehuss opened this issue Nov 14, 2024 · 1 comment
Labels
Meta Non-content issues (procedure, tooling, website, etc.)

Comments

@ehuss
Copy link
Contributor

ehuss commented Nov 14, 2024

I think it would be helpful to have some kind of tooling to help check or enforce spelling in the reference. I think a challenge is picking the right tooling for that. Some of the considerations:

  • How easy is the tooling to use?
    • How easy is it to install and run locally?
    • How easy is it to add unknown words?
    • How much of a roadblock will this be for contributors?
    • How stable is it?
    • How well does it handle code?
  • What dictionary to use?

I'm aware of a few tools, though I'm sure there are others:

This is split off from #599.

@ehuss ehuss added the Meta Non-content issues (procedure, tooling, website, etc.) label Nov 14, 2024
@ehuss ehuss mentioned this issue Nov 14, 2024
@CramBL
Copy link
Contributor

CramBL commented Nov 22, 2024

I would recommend just starting out with typos because:

  • Very quick to get started -> having something is 1000x better than having nothing
  • Designed for low rate of false-positives -> doesn't bother contributors unnecessarily
  • Easy to configure, easy to use
  • Fast (built in Rust)
  • Used by plenty of large projects, e.g. rerun

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Meta Non-content issues (procedure, tooling, website, etc.)
Projects
None yet
Development

No branches or pull requests

2 participants