Skip to content

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

Merged
alejoe91 merged 42 commits intoAllenNeuralDynamics:mainfrom
yarikoptic:enh-codespell
Jun 4, 2025
Merged

Add codespell support (config, workflow to detect/not fix) and make it fix some typos#49
alejoe91 merged 42 commits intoAllenNeuralDynamics:mainfrom
yarikoptic:enh-codespell

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.

alejoe91 and others added 8 commits June 3, 2025 17:47
…(but ignoring overall fail due to ambigous ones)

=== Do not change lines below ===
{
 "chain": [],
 "cmd": "codespell -w || :",
 "exit": 0,
 "extra_inputs": [],
 "inputs": [],
 "outputs": [],
 "pwd": "."
}
^^^ Do not change lines above ^^^
…nteractively

=== Do not change lines below ===
{
 "chain": [],
 "cmd": "codespell -w  -w -i 3 -C 4",
 "exit": 0,
 "extra_inputs": [],
 "inputs": [],
 "outputs": [],
 "pwd": "."
}
^^^ Do not change lines above ^^^
@alejoe91
Copy link
Collaborator

alejoe91 commented Jun 4, 2025

Thanks @yarikoptic

I'm almost done merging this v1.0 PR #46, so I would port the action and changes there. Is that ok?

@alejoe91 alejoe91 changed the base branch from main to improve-user-exp June 4, 2025 14:36
@alejoe91 alejoe91 changed the base branch from improve-user-exp to main June 4, 2025 14:47
@yarikoptic
Copy link
Contributor Author

whatever works for you, or I could just redo this PR later if that would be easiler/cleaner ... takes me just a minute or so. just let me know

unrelated: did my email with subject "codec for neural data" reach you?

@alejoe91
Copy link
Collaborator

alejoe91 commented Jun 4, 2025

Thanks @yarikoptic

I'm almost done merging this v1.0 PR #46, so I would port the action and changes there. Is that ok?

whatever works for you, or I could just redo this PR later if that would be easiler/cleaner ... takes me just a minute or so. just let me know

unrelated: did my email with subject "codec for neural data" reach you?

yes, thanks for the reminder! I'll reply today :)

@alejoe91 alejoe91 merged commit 9256528 into AllenNeuralDynamics:main Jun 4, 2025
3 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