Skip to content

Automated spell checking #1675

Open
Open

Description

@ehuss

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.

Activity

  1. added
    MetaNon-content issues (procedure, tooling, website, etc.)
    on Nov 14, 2024
  2. CramBL commented on Nov 22, 2024

    @CramBL
    Contributor

    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

Metadata

Metadata

Assignees

No one assigned

    Labels

    MetaNon-content issues (procedure, tooling, website, etc.)

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions