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

Merged
merged 4 commits into from
Dec 20, 2024

Conversation

yarikoptic
Copy link
Contributor

Missed your talk yesterday :-/ mind sharing slides for a peak?

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.

…(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 ^^^
=== Do not change lines below ===
{
 "chain": [],
 "cmd": "codespell -w -i 3 -C 2 CHANGELOG.md",
 "exit": 0,
 "extra_inputs": [],
 "inputs": [],
 "outputs": [],
 "pwd": "."
}
^^^ Do not change lines above ^^^
@bbfrederick
Copy link
Owner

It's been 3 months since the last non-dependabot PR, and you and I both put one in within a 1 or 2 minute period. What are the odds?

I'll need to make sure they don't clash - mine's a pretty big one, and has a number of documentation patches.

I don't think you really missed much in my talk - we ran over time so didn't get to mention a lot of what we wanted to talk about. Happy to send you the slides though.

@bbfrederick bbfrederick merged commit c854367 into bbfrederick:main Dec 20, 2024
13 checks passed
@yarikoptic
Copy link
Contributor Author

What are the odds?

Last minute shoppingwork before the holidays?!

You could have easily delayed my PR -- the last commit(s) are rerunnable, so we could pretty much datalad rerun --onto fresh-master the whole thing on top of your new state of things after you are done!

@bbfrederick
Copy link
Owner

Turns out they didn't clash at all (my PR had some things that had to be manually merged, but that's because I moved around and renamed a lot of file and git was NOT happy about it). They're both in now. I forgot to put your name into pyproject.toml, but it's in there now for 3.0alpha2.

@yarikoptic
Copy link
Contributor Author

Oi... am I responsible for it now? ;-)

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