rust-lang / rust-lang/reference
Automated spell checking
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 1.6k
- Forks
- 607
- PR merge metrics
- PR metrics pending
Description
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:
- typos
- aspell (used by the Rust Book)
- ispell
- hunspell
- cargo spellcheck (not sure if that supports markdown)
- spellcheck-cli
This is split off from #599.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Compare typos, aspell, ispell, hunspell, cargo spellcheck, and spellcheck-cli against the installation, dictionary, contributor, stability, and code-handling concerns listed in the issue. The payload names no files or tests; done means selecting suitable tooling and a dictionary, then defining how spelling is checked or enforced for the reference.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100