search

nmfs-ost / ss3-doc

Source code for the Stock Synthesis manual and other documentation
https://nmfs-ost.github.io/ss3-website/
Creative Commons Zero v1.0 Universal
4 stars 3 forks source link

GitHub action to spellcheck latex docs #228

Closed e-perl-NOAA closed 6 months ago

e-perl-NOAA commented 6 months ago

Resolves issue #227

Using textidote there are a lot of things that are flagged that aren't necessarily errors. The args portion of the action has an ignore portion that I use to ignore certain rules but there are others that I don't think should be ignored and I'm okay with those warnings persisting. I also have a dictionary for flagged words that aren't actually misspellings (fisheries specific, hyperlink tags, etc.). Even with all of that, there are 444 warnings that I could not get rid of and I'm okay with that. I have the action producing an artifact of the textidote report and failing if it goes over that number (444) of warnings. If more warnings are introduced in the future that can't be gotten rid of, that number can always change. I'm open to suggestions too. This did take a long time to sort out to get as few warnings as possible (like an embarrassingly long time), but all for the best since there were quite a few things to correct and sort out.

A general guide with textidote is that red = misspelled words, and orange and yellow or smaller grammatical and formatting things. There is one "misspelled" word with special characters for a hyperlink that I have tried many times to resolve in the dictionary.txt file (which is mostly alphabetical) but couldn't and admitted defeat.

iantaylor-NOAA commented 6 months ago

Update: I found the textidote_report in the artifacts for the existing github action (I hadn't noted that it wasn't a separate action): https://github.com/nmfs-ost/ss3-doc/actions/runs/9119219932. I agree that the remaining issues the checker flags can be ignored and it's not worth making more of them go away at this stage.