Implementing an automatic spellcheck GitHub action. #748
Conversation
…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.
|
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 |
kd-ods
left a comment
There was a problem hiding this comment.
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.
|
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. |
kd-ods
left a comment
There was a problem hiding this comment.
Thanks, Kathryn - this look great. And I can see the new check works on this PR
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
translating. See the Handbook
Documentation & Release