-
Notifications
You must be signed in to change notification settings - Fork 59
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
Conversation
1684e23
to
5890061
Compare
5890061
to
c43002d
Compare
* 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]>
c43002d
to
b1c4658
Compare
There was a problem hiding this 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.
.pandoc_template.html5
Outdated
@@ -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: |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
.
There was a problem hiding this comment.
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
34e14cd
to
528a1f0
Compare
528a1f0
to
7d889dd
Compare
# codespell:ignore word
..codespell_ignores
file.skip =
to the.codespellrc
file.