More type hinting for the codebase

[PinkShnack]

Continuing to solve the issue #198.

• dclab/features
• dclab/features/emodulus
• Is there a numpy typing module extension + sphinx extension for making the API reference output "simpler" or more human readable?
  • See here for shorter version: https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autodoc_typehints_format
    • Doesn't give us anything currently, might be useful when type hinting the internal data structures.
  • and here for aliases, which adds some overhead for us: https://stackoverflow.com/questions/67473396/shorten-display-format-of-python-type-annotations-in-sphinx
    • Not worth the overhead imo, as the most complicated type is npt.NDArray, and we want to keep that open to dtype anyway.
• Go through type hinted functions and put back in docstring human readable types and shapes. Do consistently, not necessarily as before.
• update changelog

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.38%. Comparing base (2fe07f7) to head (10d89b6).
⚠️ Report is 6 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #265      +/-   ##
==========================================
+ Coverage   91.35%   91.38%   +0.02%     
==========================================
  Files         110      110              
  Lines        8214     8238      +24     
==========================================
+ Hits         7504     7528      +24     
  Misses        710      710              

☔ 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.

[PinkShnack]

@paulmueller
When you get a chance, please review this! I have a comment above also that I wasn't sure about.

[PinkShnack]

Hey, can I change the version in the changelog and merge this?

[paulmueller]

Please check whether numpydoc works and the API reference compiles properly when you omit the colon after the parameter name. I commented on it a few times, but you removed them in many more places.

[PinkShnack]

Regarding the docstring parameter types: imo there should either be type hints OR docstring descriptions. Otherwise, future maintenence requires changing two things for one purpose. That's why I removed the docstring parameter types after the colons. For example, when using Sphinx with autodoc_typehints = "description", then the Code (API) reference looks like this:

[paulmueller]

OK good, then the docs render correctly without the colon. Please re-insert the info about dimensionality wherever you removed it and I will merge.

[PinkShnack]

Hey @paulmueller, can you please review? Especially the new section in the README. Thanks!

[paulmueller]

Looks good to me. If you have nothing else to add, I will merge!

[PinkShnack]

Please merge! :)