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

Release preparation: Run codespell. #15386

Merged
merged 4 commits into from Jun 20, 2023
Merged

Conversation

drwells
Copy link
Member

@drwells drwells commented Jun 20, 2023

I ran codespell, our own detect double-word typos script, and typos.

@marcfehling
Copy link
Member

/rebuild

@bangerth bangerth added this to the Release 9.5 milestone Jun 20, 2023
Copy link
Member

@bangerth bangerth left a comment

Choose a reason for hiding this comment

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

Very nice!

How hard would you think it is to hook whatever script you ran into the CI?

@tamiko tamiko changed the title [9.5] Run codespell. Release preparation: Run codespell. Jun 20, 2023
@drwells
Copy link
Member Author

drwells commented Jun 20, 2023

These spellcheckers are not a good fit for the CI since we use a lot of non-English words. Some examples:

  1. Both typos and codespell want to correct compute_2nd_derivatives in different ways
  2. Many of our abbreviations (e.g., Numer.) are correct, but they don't know this
  3. We use a lot of short-hand variables (like eu) that are also technically correct
  4. non-English family names (Linz, Stoer)

We'd have to maintain a pretty substantial additional word list to make these tools run cleanly. I think its wiser to just run them at release time and manually inspect the output.

@bangerth
Copy link
Member

Ah, thanks!

Copy link
Member

@kronbichler kronbichler left a comment

Choose a reason for hiding this comment

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

Thank you. It is always interesting to see how many typos are slipping through, and it is great to have this step once per year.

substract_and_norm(
subtract_and_norm(
Copy link
Member

Choose a reason for hiding this comment

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

😄

@marcfehling marcfehling merged commit 971eabf into dealii:master Jun 20, 2023
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants