Skip to content

Implementing an automatic spellcheck GitHub action. #748

Merged
kathryn-ods merged 11 commits intomainfrom
spellcheck
Jul 8, 2025
Merged

Implementing an automatic spellcheck GitHub action. #748
kathryn-ods merged 11 commits intomainfrom
spellcheck

Conversation

@kathryn-ods
Copy link
Contributor

Overview

What does this pull request do?

Adds 3 files - the GitHub action file, the spellcheck configuration file and a list of allowed words not in the dictionary. I have also corrected some spelling errors which were flagged up by the spell checker.

How can a reviewer test or examine your changes?
Add in a spelling error

Who is best placed to review it?
@kd-ods

Closes #

Translations

  • New or edited strings appearing as a result of this PR will be picked up for translation
  • I've notified the translation coordinator of any new strings that will need
    translating. See the Handbook

Documentation & Release

…iles - the GitHub action file, the spellcheck configuration file and a list of allowed words not in the dictionary. I have also corrected some spelling errors which were flagged up during the implementation of the spellchecker.
@kathryn-ods
Copy link
Contributor Author

At the moment linkcheck is failing because https://www.icao.int/publications/Documents/9303_p3_cons_en.pdf and https://www.icao.int/publications/Documents/9303_p4_cons_en.pdf are down - I expect if we rerun the tests next week it'll work again

@kathryn-ods kathryn-ods requested a review from kd-ods June 20, 2025 15:55
Copy link
Collaborator

@kd-ods kd-ods left a comment

Choose a reason for hiding this comment

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

A couple of little things to consider, suggestion-wise.

A bigger thing: the edits to the reference.rst page break the internal links to those sections. You'll need to build the docs to see what I mean. So you'll need to find all the properties that link to them and use the ':externallinks:' parameter to set up a link with a hyphen. It's a bit of a palaver. (Feel free to revert your changes on that page. Better to break the style guide than the links!) If you do want to make the reference.rst edits, you'll also need to make the underline under 'Unspecified Record' longer.

And one final thing (sorry!) - is there any way of putting the .spellcheck.yml and .wordlist.txt files in the workflows directory? Just for tidiness' sake.

@kathryn-ods
Copy link
Contributor Author

Thanks Kadie - have reverted the reference.rst page where links were broken and changed those specific words you highlighted.

I have moved wordlist.txt into the workflows folder but can't move spellcheck.yml without it breaking. It's got the . in front so it's a "hidden" file.

@kathryn-ods kathryn-ods requested a review from kd-ods July 2, 2025 14:41
Copy link
Collaborator

@kd-ods kd-ods left a comment

Choose a reason for hiding this comment

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

Thanks, Kathryn - this look great. And I can see the new check works on this PR

@kathryn-ods kathryn-ods merged commit d97e798 into main Jul 8, 2025
6 checks passed
@kathryn-ods kathryn-ods deleted the spellcheck branch July 8, 2025 08:35
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.

2 participants