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

added "abd" to the codespellignore #238

Merged
merged 2 commits into from
Jan 29, 2025
Merged

Conversation

lzehl
Copy link
Member

@lzehl lzehl commented Jan 27, 2025

added "abd" (abbreviation for Andor Bio-Imaging Division) to the codespellignore

@lzehl lzehl requested a review from apdavison January 27, 2025 12:03
@apdavison
Copy link
Member

I can't remember if it is this file, or .codespellrc, that codespell uses for its ignore list. Perhaps make the change in both files to be safe? (or we can take the time to figure this out, and delete what's not needed)

@lzehl
Copy link
Member Author

lzehl commented Jan 28, 2025

@apdavison I added the abbreviation (non-capitalized and capitalized) to the .codespellrc in the ignore-words-list. Not sure if the .codespellignore is actually needed/used looking at the codespell docu (@yarikoptic?)

@yarikoptic any best practice suggestions for dealing with ignore words/files in codespell?

@lzehl
Copy link
Member Author

lzehl commented Jan 29, 2025

@yarikoptic @apdavison I'm opening a separate issue for figuring out the codespell best practices.

@yarikoptic
Copy link
Contributor

Yeah, I don't think .codespellignore is used any longer, I usually just do what @lzehl did for such cases. If word is rare, and you could add a comment (eg in the code), you could add inline ignores: https://github.com/codespell-project/codespell?tab=readme-ov-file#inline-ignore

@Raphael-Gazzotti Raphael-Gazzotti merged commit c863c27 into main Jan 29, 2025
1 check passed
@Raphael-Gazzotti Raphael-Gazzotti deleted the lzehl_codespellignore-abd branch January 29, 2025 13:55
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.

4 participants