Skip to content

Introduce spell checking #731

@MothNik

Description

@MothNik

I noticed this one while I was working on #632:
I've found a few tiny typos here and there throughout the codebase. To avoid this, I usually use tools like cspell which has amazing IDE integration.

From a basic workflow, all that's required is to add a custom cspell.json-file. In this file, all expressions that are not recognized as words (e.g. pylops, signalprocessing) can be added in a custom dictionary. This dictionary is subject to version control and whenever one developer adds a new word, this word is also known by the cspell of other developers working on pylops after a pull/merge.

All expressions that are not considered as words and cannot be found in this dictionary will be underlined and flagged as typos by cspell until fixed or added to the dictionary. There is even a cli-tool for this, which would be a great addition to a CI workflow aside from linting.

The nice thing about this is that it requires very little commitment. Whenever one encounters an unknown expression, one can either add it to the dictionary or fix the typo. Consequently, the codebase would be cleared from typos step by step with every commit. After some transition phase, spell checking could then be made mandatory and run in the CI.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions