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

Add codespell support (config, workflow to detect/not fix) and make it fix few typos #493

Merged
merged 7 commits into from
Dec 18, 2024

Conversation

yarikoptic
Copy link
Contributor

More about codespell: https://github.com/codespell-project/codespell .

I personally introduced it to dozens if not hundreds of projects already and so far only positive feedback.

CI workflow has 'permissions' set only to 'read' so also should be safe.

I ignored all /old/ stuff, but that Enrichment-Results-Analysis.ipynb has a good number of typos which could be fixed

…agically

=== Do not change lines below ===
{
 "chain": [],
 "cmd": "codespell -w",
 "exit": 0,
 "extra_inputs": [],
 "inputs": [],
 "outputs": [],
 "pwd": "."
}
^^^ Do not change lines above ^^^
.gitignore Show resolved Hide resolved
@caufieldjh
Copy link
Member

caufieldjh commented Dec 18, 2024

Thanks @yarikoptic !
I'm generally in favor of codespell with the sole reservation that it doesn't handle biomedical terms as consistently as I may like.
I'm also going to move the Codespell workflow into the existing QC workflow (in its own PR).

@caufieldjh caufieldjh merged commit cd28a9b into monarch-initiative:main Dec 18, 2024
5 checks passed
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