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.

Sign up for GitHub

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

Jump to bottom

Fix more typos #3636

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Fix more typos #3636

wants to merge 4 commits into from

Conversation

szepeviktor
Copy link
Member

@szepeviktor szepeviktor commented Nov 22, 2023 •
edited

Before submitting your PR, please review the following checklist:

  • CHOOSE CORRECT BRANCH: if filing a bugfix/enhancement
    against certain release version, choose 0.9, 0.10 or 0.11 branch,
    for dev-edition use master branch
  • CONSIDER adding a unit test if your PR resolves an issue
  • LIST ISSUES this PR resolves
  • MAKE SURE this PR doesn't break existing tests
  • KEEP PR small so it could be easily reviewed.
  • AVOID making unnecessary stylistic changes in unrelated code
  • ACCOMPANY each new failregex for filter X with sample log lines
    within fail2ban/tests/files/logs/X file

typos is a superior tool. You can see it in this PR.
Codespell uses regular expressions, typos understands source code.

From #3630

@szepeviktor szepeviktor changed the title Typos Fix more typos Nov 22, 2023
sebres
sebres reviewed Nov 26, 2023
View reviewed changes
Copy link
Contributor

@sebres sebres left a comment

Choose a reason for hiding this comment

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

Shall .typos.toml not be completely excluded by spelling check?

@szepeviktor
Copy link
Member Author

szepeviktor commented Nov 26, 2023 •
edited

I think you mean adding it to .codespellrc
I propose to use typos.

@sebres
Copy link
Contributor

sebres commented Nov 26, 2023

I meant it introduces failure in CI now, so to pass Codespell flow it must be ignored.

As for proposal to use topos, I don't think we need 2 spell checking flows in CI, so a better of both must be chosen. Is typos supported by GHA? Or would you like to use it locally only and just check-in it in repo?

@szepeviktor
Copy link
Member Author

Is typos supported by GHA?

Yes it is.
https://github.com/marketplace/actions/typos-action
But if you look into it, it is terrible.
I run it in GHA with a few lines: https://github.com/szepeviktor/byte-level-care/blob/e0b3ee5a8aa77126e8f80eca0c55ce5026c23432/.github/workflows/spelling.yml#L31-L50

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sebres sebres sebres left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@szepeviktor @sebres