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 #313

Merged
merged 6 commits into from
Jun 14, 2024

Conversation

yarikoptic
Copy link
Contributor

@yarikoptic yarikoptic commented Jun 10, 2024

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.

Note that I did fixup typos in ./pypet2bids/pypet2bids/ecat_headers.json


📚 Documentation preview 📚: https://pet2bids--313.org.readthedocs.build/en/313/

=== Do not change lines below ===
{
 "chain": [],
 "cmd": "git-sedi 'thes frame' 'the frame'; git-sedi labled labeled",
 "exit": 0,
 "extra_inputs": [],
 "inputs": [],
 "outputs": [],
 "pwd": "."
}
^^^ Do not change lines above ^^^
…(but ignoring overall fail due to ambigous ones)

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

@bendhouseart bendhouseart left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can't believe we made any mistakes, but aparantly we did. Ty @yarikoptic

@bendhouseart bendhouseart merged commit f6e221b into openneuropet:main Jun 14, 2024
8 of 10 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