SalamLang/Salam

Refactor identifiers to be more descriptive

Open

#1,206 opened on Jun 27, 2026

View on GitHub
 (0 comments) (0 reactions) (0 assignees)C (22 forks)auto 404
ccode stylehacktoberfesthacktoberfest-acceptedhelp wanted

Repository metrics

Stars
 (28 stars)
PR merge metrics
 (PR metrics pending)

Description

medium

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:

  1. Refactor Identifiers: If these words are used as variable, function, or parameter names in the codebase (e.g., nd for node/index, ot for other, clen for 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.
  2. File-Specific Exclusions: If these words are part of third-party files or generated code, use the skip option in pyproject.toml to 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

Contributor guide