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 a GitHub Action to find typos with codespell #466

Closed
wants to merge 1 commit into from

Conversation

cclauss
Copy link
Contributor

@cclauss cclauss commented Dec 26, 2023

This GitHub Action uses minimal steps to run in ~5 seconds to rapidly look for typos in the codebase using codespell.


Marmalade, I like marmalade...

https://en.wikipedia.org/wiki/Alan%27s_Psychedelic_Breakfast

Copy link
Contributor

@fangerer fangerer left a comment

Choose a reason for hiding this comment

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

I'm fine with that but would like to wait for a second opinion.
@mattip @hodgestar @antocuni What do you think?

Copy link
Contributor

@hodgestar hodgestar left a comment

Choose a reason for hiding this comment

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

Also happy with this, but let's let a couple more people chime in an perhaps ping everyone on Discord?

Very happy to see the various typos cleaned up.

@steve-s
Copy link
Contributor

steve-s commented Dec 27, 2023

I like that the codespell caught real errors. I don't have a strong opinion on ruff, but there was already a declined PR to enable it. Has anything changed since then? Does this PR enable it in some other way than the previous?

@cclauss
Copy link
Contributor Author

cclauss commented Dec 27, 2023

I would say that a ton has changed given the rapid adoption of ruff. It now has more than 700 lint rules, a conservative --fix capability, and a code formatter that is certainly faster than and often preferred over black.

@mattip
Copy link
Contributor

mattip commented Jan 11, 2024

As I commented in the other PR I think we are not in need of ruff right now. I said there:

I think we should reject this PR. The only time code formatting has become a discussion topic is when use of a tool to format code is proposed. This seems to be the flip side of the "code formatters prevent discussions around formatting": to become "code formatters generate unhelpful and long discussions around code formatting".

@mattip
Copy link
Contributor

mattip commented Jan 11, 2024

PRs that contribute to the adoption and development of HPy would be much more helpful.

@cclauss cclauss changed the title Add a GitHub Action to run codespell and ruff Add a GitHub Action to find typos with codespell Jan 11, 2024
@cclauss
Copy link
Contributor Author

cclauss commented Jan 30, 2024

Linting with ruff has been removed.

@cclauss cclauss closed this Apr 26, 2024
@cclauss cclauss deleted the codespell-and-ruff branch April 26, 2024 13:16
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.

None yet

6 participants