Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cleanup codespell ignore patterns #4175

Merged
merged 9 commits into from
Nov 16, 2024

Conversation

DanielYang59
Copy link
Contributor

@DanielYang59 DanielYang59 commented Nov 15, 2024

Cleanup codespell ignore patterns

Currently a lot of global ignore patterns are very specific to a certain module (or even one line), there's no good reason to ignore a pattern globally for such cases. Admittedly it will be a balance between convenience (no one want to insert a # codespell:ignore tag every line) and correctness (some patterns are very specific to few lines across the code base, but are real typos elsewhere, like lamda/coul, do note).

Changes:

  • Keep the global pattern when it's very common: Elements like Nd/Te, or very common for a commonly used module, TITEL for VASP for example, or our good friend atomate
  • Rename some internal/test variables when it's not breaking (usually increase readability)
  • Ignore all JSON files as comments are not allowed in JSON, we might safely assume everything is intended in JSON

Follow up

@DanielYang59 DanielYang59 marked this pull request as ready for review November 16, 2024 13:30
@shyuep shyuep merged commit c72c9e9 into materialsproject:master Nov 16, 2024
43 checks passed
@DanielYang59 DanielYang59 deleted the cleanup-codespell-ignore branch November 16, 2024 13:38
@DanielYang59
Copy link
Contributor Author

Thanks! Currently codespell doesn't seem to support block/file level support with pattern, I would update once they do.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants