Adopt pre commit hook for the codespell tool

[davidorme]

Description

Does exactly what it says on the title.

Oh, and also fixes all the existing typos and stress up the configuration. The new .codespellignore.txt file is there to stop it moaning about matric.

Fixes #846

Type of change

• New feature (non-breaking change which adds functionality)
• Optimization (back-end change that speeds up the code)
• Bug fix (non-breaking change which fixes an issue)

Key checklist

• Make sure you've run the pre-commit checks: $ pre-commit run -a
• All tests pass: $ poetry run pytest

Further checks

• Code is commented, particularly in hard-to-understand areas
• Tests added that prove fix is effective or that feature works
• Relevant documentation reviewed and updated

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.76%. Comparing base (f940858) to head (3fcaa9f).

Additional details and impacted files

@@           Coverage Diff            @@
##           develop     #847   +/-   ##
========================================
  Coverage    94.76%   94.76%           
========================================
  Files           75       75           
  Lines         5563     5563           
========================================
  Hits          5272     5272           
  Misses         291      291           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[vgro]

Brilliant, I'm always amazed what the human eye can ignore ;-)

[jacobcook1995]

Wow, I am pretty surprised by how well that worked! Only one word to ignore on the entire code base is amazingly good going

[davidorme]

Wow, I am pretty surprised by how well that worked! Only one word to ignore on the entire code base is amazingly good going

It's not a complete spellchecker - it looks for particular misspellings - so there may be some uncommon typos in technical words. But still pretty useful. Thanks for the tip @alexdewar