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

Spellcheck #397

Closed
wants to merge 20 commits into from
Closed

Spellcheck #397

wants to merge 20 commits into from

Conversation

wxtim
Copy link
Member

@wxtim wxtim commented Feb 9, 2022

Add sphinxcontrib-spellcheck.
The problem is that despite configuring it to use lang='en_GB' this doesn't seem to be all that reliable and tends to object to non US English.
Having run the spell check recently, however, I think it's worth putting this up, despite its weaknesses.

Further work - we should decide which of the two valid spelling of "parameteri[sz]e" we want to use. Both are legal in UK English, although "z" is a bit archaic.

wxtim added 11 commits November 20, 2021 23:46
* 'master' of github.com:cylc/cylc-doc: (119 commits)
  Fix additional tutorials (cylc#388)
  Update script item style reccommendations (cylc#392)
  Workaround pygraphviz 1.8 bug for pip 22 / py 3.7
  Re write of the cylc tutorials (cylc#383)
  Fix reference
  Add reference section for job script env vars
  Autodocument Traitlets from UI Server (cylc#385)
  fix heading levels
  Revise simulation modes doc.
  response to review.
  response to review.
  Update src/reference/config/writing-platform-configs.rst
  Update src/7-to-8/major-changes/cli.rst
  728: fix broken reference and remove play/pause/stop symbols
  Update src/7-to-8/major-changes/compatibility-mode.rst
  Update src/7-to-8/major-changes/cli.rst
  728: summary++
  728: play pause stop
  728: fix graph branching docs
  728: cylc install migration guide improvements
  ...
* 'master' of github.com:cylc/cylc-doc:
  Update src/workflow-design-guide/general-principles.rst
  Update src/workflow-design-guide/general-principles.rst
  design guide: update for cylc 8
* 'master' of github.com:cylc/cylc-doc:
  fix small spelling errors (cylc#396)
@wxtim wxtim requested review from MetRonnie, oliver-sanders and datamel and removed request for oliver-sanders February 9, 2022 11:32
src/conf.py Outdated Show resolved Hide resolved
acknowledgement
aldergrove
analyse
aren
Copy link
Member

Choose a reason for hiding this comment

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

Does it not handle contractions with apostrophes? e.g. aren't

Copy link
Member Author

@wxtim wxtim Feb 9, 2022

Choose a reason for hiding this comment

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

src/spelling_wordlist.txt Show resolved Hide resolved
src/spelling_wordlist.txt Show resolved Hide resolved
@wxtim wxtim marked this pull request as draft February 9, 2022 16:12
@wxtim
Copy link
Member Author

wxtim commented Feb 9, 2022

pyenchant/pyenchant#93

(Pyenchant not actively maintained)

@wxtim
Copy link
Member Author

wxtim commented Feb 9, 2022

@oliver-sanders @MetRonnie
It looks like Pyenchant is a dangerously under-supported library (pyenchant/pyenchant#93) - and getting it to pass is becoming tricky. I can just pull the words it doesn't like off GHA and fix it manually, but I'm not sure I like the level of faffing.

Happy to

  1. Close
  2. Just accept that we might have a lot of exceptions in the custom dict and use it to spot future spelling fialures.

@MetRonnie
Copy link
Member

Hmm, probably not worth the effort then

@wxtim
Copy link
Member Author

wxtim commented Feb 10, 2022

Hmm, probably not worth the effort then

All option 2 requires is piping the output of the make spelling to a well constructed awk command and then quickly checking the output of the awk command for obviously wrong stuff.

We then have a working setup which will object to new typos.

@wxtim
Copy link
Member Author

wxtim commented Feb 10, 2022

Not worth it for reasons described above.

@wxtim wxtim closed this Feb 10, 2022
@wxtim wxtim mentioned this pull request Feb 10, 2022
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