Spelling

[ewjoachim]

Adding a spell check validation on the CI because:

• I write bad
• It's annoying to see these typos afterwards
• Machines are sometimes better than humans for spotting those
• It's usually less judgmental to take criticism on your spelling from a machine than from a human.

Successful PR Checklist:

• Tests < (well new CI checks anyway)
• Documentation
• Had a good time contributing? (if not, feel free to give some feedback)

[ewjoachim]

Ok, I'm not sure about this.
I like the idea of it, but sphinxcontrib-spelling is built on top of PyEnchant (unmaintained), itself built on top of enchant (C lib, installed system-wide).

In order to make it work on the CI, I have to install enchant manually AND apparently, the default dictionary is different from the one on my laptop, which makes PRs that pass locally and fail in the CI. Red flags galore.

Can you think of an alternative ? A sane path forward ?

[ewjoachim]

Ok, I think the best to do with this PR is to integrate it as an optional tool that won't break the CI and won't prevent people from contributing if it doesn't work, but will let us check easily from times to times.

[ewjoachim]

Ready for review !

everything changed

[sophie-ulti]

Good idea !

[codecov-io]

Codecov Report

Merging #77 into master will not change coverage.
The diff coverage is n/a.

@@          Coverage Diff          @@
##           master    #77   +/-   ##
=====================================
  Coverage     100%   100%           
=====================================
  Files          20     20           
  Lines         783    783           
  Branches       65     65           
=====================================
  Hits          783    783

Impacted Files	Coverage Δ
procrastinate/tasks.py	100% <ø> (ø)	⬆️
procrastinate/retry.py	100% <ø> (ø)	⬆️
procrastinate/testing.py	100% <ø> (ø)	⬆️
procrastinate/app.py	100% <ø> (ø)	⬆️
procrastinate/jobs.py	100% <ø> (ø)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4beecce...215385d. Read the comment docs.