Move class documentation to class docstrings

[natestemen]

Description

By default Sphinx uses class docstrings when building documentation pages, instead of docstrings from special functions like __init__ (see the sphinx variable autoclass_content¹ for more details). We had a few instances of valuable documentation hiding in __init__ docstrings that was never being displayed in the API-doc! This PR remedies that by ensuring it is picked up by sphinx.

Footnotes

1. One can set this variable to look at both the class docstring and the __init__ function, but it then creates duplicated sections specifying the arguments to the class. ↩

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.72%. Comparing base (411e234) to head (ef70732).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2525   +/-   ##
=======================================
  Coverage   98.72%   98.72%           
=======================================
  Files          90       90           
  Lines        4156     4156           
=======================================
  Hits         4103     4103           
  Misses         53       53           

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

[cosenal]

👍 thanks