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

ci: Check spelling with codespell #511

Merged
merged 2 commits into from
Feb 13, 2025
Merged

ci: Check spelling with codespell #511

merged 2 commits into from
Feb 13, 2025

Conversation

spetrosi
Copy link
Contributor

@spetrosi spetrosi commented Feb 7, 2025

  • You can ignore words inline by adding a comment like # codespell:ignore word.
  • You can ignore words by adding them to the .codespell_ignores file.
  • You can ignore files and directories by adding them with skip = to the .codespellrc file.

@spetrosi spetrosi self-assigned this Feb 7, 2025
@spetrosi spetrosi force-pushed the codespell-init branch 4 times, most recently from 1684e23 to 5890061 Compare February 12, 2025 11:23
@spetrosi spetrosi changed the title ci: Replace woke with codespell ci: Check spelling with codespell Feb 12, 2025
* You can ignore words inline by adding a comment like `# codespell:ignore word`.
* You can ignore words by adding them to the `.codespell_ignores` file.
* You can ignore files and directories by adding them with `skip = ` to the `.codespellrc` file.

Signed-off-by: Sergei Petrosian <[email protected]>
Copy link
Collaborator

@vojtechtrefny vojtechtrefny left a comment

Choose a reason for hiding this comment

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

Looks good to me.

@@ -25,7 +25,7 @@ Copyright (c) 2017 GitHub Inc.

"GitHub Pandoc HTML5 Template" is Copyright (c) Tristano Ajmone, 2017-2020,
released under the MIT License (MIT); it contains readaptations of substantial
portions of the following third party softwares:
portions of the following third party software:
Copy link
Collaborator

Choose a reason for hiding this comment

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

If this is a part of the copyright/license, we probably shouldn't change it. But I am not a licensing expert.

Copy link
Contributor

Choose a reason for hiding this comment

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

I would prefer not to change it, but if we don't change it, how do we tell codespell to ignore it? Note that in English, softwares is incorrect - software is both singular and plural.

Copy link
Collaborator

Choose a reason for hiding this comment

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

If I understand it correctly, this file is generated and we are not really expected to change it, right? So I think we can just skip it in .codespellrc.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I was searching for a good template at the time and copied this from https://github.com/tajmone/pandoc-goodies/blob/master/templates/html5/github/GitHub-Template-Preview.html
I reverted this and added .pandoc_template.html5 to .codespellrc

@spetrosi spetrosi merged commit b331fa6 into main Feb 13, 2025
17 checks passed
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