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: config, workflow, pre-commit config and make it fix few typos #1219

Merged
merged 11 commits into from
Jan 23, 2024

Conversation

yarikoptic
Copy link
Contributor

  • I have added a news fragment under changelog.d/ (if the patch affects the end users)

it doesn't so I didn't bother

I see that once in a while commits fixing typos come in. With https://github.com/codespell-project/codespell you could minimize them even further since it would be harder for them to sneak in.

pyproject.toml Outdated Show resolved Hide resolved
@chrysle
Copy link
Contributor

chrysle commented Jan 19, 2024

Thanks! Why did you add codespell both as a pre-commit hook and a GH Actions workflow?

@yarikoptic
Copy link
Contributor Author

just what my https://github.com/yarikoptic/improveit/blob/main/codespellit does since not necessarily people have pre-commit as a service or a workflow ;) I will drop the commit adding github action now.

@chrysle
Copy link
Contributor

chrysle commented Jan 19, 2024

LGTM, please rebase or merge.

Copy link
Contributor

@Gitznik Gitznik left a comment

Choose a reason for hiding this comment

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

Thanks for suggesting this. Let's hope it will cut some manual effort in the future.
Have you run it on all current files?

Also - is it necessary to exclude the vens nox creates from checking when doing a run on all files?

pyproject.toml Outdated Show resolved Hide resolved
@yarikoptic
Copy link
Contributor Author

Thanks for suggesting this. Let's hope it will cut some manual effort in the future. Have you run it on all current files?

yes, codespell considers all the applicable (non binary) files AFAIK. There is a commit done via datalad run with annotation on execution

Also - is it necessary to exclude the vens nox creates from checking when doing a run on all files?

cool, adding .nox to excludes (and something for my codespellit script to look for)

@yarikoptic
Copy link
Contributor Author

LGTM, please rebase or merge.

pushed rebased

Gitznik
Gitznik previously approved these changes Jan 20, 2024
Copy link
Contributor

@chrysle chrysle left a comment

Choose a reason for hiding this comment

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

Still waiting for codespell to support .gitignore files.

pyproject.toml Outdated Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
chrysle
chrysle previously approved these changes Jan 22, 2024
@chrysle
Copy link
Contributor

chrysle commented Jan 22, 2024

@yarikoptic Could you rebase again, please?

auto-merge was automatically disabled January 22, 2024 21:46

Head branch was pushed to by a user without write access

@yarikoptic
Copy link
Contributor Author

done. Also added to skip .mypy_cache

@chrysle chrysle enabled auto-merge (squash) January 23, 2024 15:05
@chrysle chrysle merged commit 10cbc9c into pypa:main Jan 23, 2024
13 checks passed
@chrysle
Copy link
Contributor

chrysle commented Jan 23, 2024

Thank you! I've taken the liberty to add a merge commit (there've been a lot of merges lately).

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.

3 participants