ccode stylehacktoberfesthacktoberfest-acceptedhelp wanted
Repository metrics
- Stars
- (28 stars)
- PR merge metrics
- (PR metrics pending)
Description
Ignoring extremely common, short typos globally (such as nd for and, ot for to/of/or, notin for not in, abd for and/add, and clen for clean/len) significantly reduces the effectiveness of the spell checker. These are very common typing mistakes that are highly likely to occur in documentation, comments, or string literals.
Recommended Approaches:
- Refactor Identifiers: If these words are used as variable, function, or parameter names in the codebase (e.g.,
ndfor node/index,otfor other,clenfor length), consider renaming them to more descriptive names (e.g.,node,other,length). This improves code readability and eliminates the need to ignore these typos. - File-Specific Exclusions: If these words are part of third-party files or generated code, use the
skipoption inpyproject.tomlto exclude those specific files or directories from codespell instead of ignoring the words globally.
Originally posted by @gemini-code-assist[bot] in https://github.com/SalamLang/Salam/pull/1205#discussion_r3485903556