You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Currently there are many component docstrings on __init__, __call__ or array_call methods which don't really say much of anything useful that the base class docstrings don't already say. For those components, we should remove the docstring entirely so that Sphinx will use the base class docstrings (which are written to be generic enough to apply to any component). The important part of the documentation is present in the *_properties dictionaries of the components.
We also could think about a way to include those property dictionaries in the documentation, but that's a separate issue.
The text was updated successfully, but these errors were encountered:
Currently there are many component docstrings on
__init__
,__call__
orarray_call
methods which don't really say much of anything useful that the base class docstrings don't already say. For those components, we should remove the docstring entirely so that Sphinx will use the base class docstrings (which are written to be generic enough to apply to any component). The important part of the documentation is present in the *_properties dictionaries of the components.We also could think about a way to include those property dictionaries in the documentation, but that's a separate issue.
The text was updated successfully, but these errors were encountered: