Add Validation Hooks For Docstrings (Numpydocs) And Spelling (Typos)

[AFg6K7h4fhy2]

Add the pre-commit hooks for numpydocs (validation numpy style docstrings) and typos (finding spelling errors). As part of this, 2 config files were added: _typos.toml and a section in ./model/pyproject.toml for numpydocs. To have numpydocs work successfully, there were small edits made across many files.

The final _typos.toml:

[default]
extend-ignore-identifiers-re = [
    "AttributeID.*Supress.*",
]

[default.extend-identifiers]
AttributeIDSupressMenu = "AttributeIDSupressMenu"

[default.extend-words]
# words that should not be corrected
damon = "Damon"

The final numpydocs checks:

[tool.numpydoc_validation]
checks = [
    "GL03",
    "GL08",
    "SS01",
    "PR03",
    "PR04",
    "PR07",
    "RT01"
]
exclude = [  # don't report on objects that match any of these regex
    '\.undocumented_method$',
    '\.__repr__$',
    '\.__call__$'
]

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.01%. Comparing base (524f708) to head (33770ca).
Report is 2 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #106      +/-   ##
==========================================
+ Coverage   91.48%   92.01%   +0.53%     
==========================================
  Files          33       34       +1     
  Lines         634      664      +30     
==========================================
+ Hits          580      611      +31     
+ Misses         54       53       -1     

Flag	Coverage Δ
unittests	92.01% <100.00%> (+0.53%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

[gvegayon]

Looks great! A few minor changes. Thanks for the heavy lift, @AFg6K7h4fhy2!

[gvegayon]

I just fixed a handful of things, @AFg6K7h4fhy2. We are good to go once checks pass.

[gvegayon]

The error in pre-commit should be fixed once the PR is merged. It is related to files that are not present in the PR but are on main.