docs: move general class docstrings from __init__ to class level for better API refs
On the new docs website we now have nice API references, however, the docstrings with a high-level description of a class do not show up because there are placed in __init__ and not at the class level:
code:
Goal for fixing this issue:
- go over all the inference classes (
NPE_X,NLE_X, etc) and move the high-level description from the__init__to the class level. Keep in__init__only a brief docstring and theArgs. - fix formatting issues in the docstrings along the way, e.g., some docstring contain html stuff like
<br/>, which should be remove (or does this have any purpose @michaeldeistler ?)
This will already addressed here
Cool! I see, in this commit there is now one sentence in each docstring.
I am wondering whether we should add more content? that content now usually lives in __init__ and will not be visible in the API docs.
Could you add a short description to that PR @michaeldeistler ? Thanks!
I would definitely go for adding the docstring in the classes and avoid the init showing up in the documentation. I thought this when modifying the documentation for BoxUniform and MultipleIndependent classes too.
It's possible to define the autoclass_content so that only class docstring is shown.