We can further reduce duplication of text in our API by replacing all high level descriptions of modules with the automodule feature. Modules have varying level of detail and should be kept up to date in the source, which is then propagated to the API.
e.g. the mhkit-python/api.mooring.rst was previously the following::
IO
""""""""""""
The io submodule contains a function to
load MoorDyn data and convert it to xarray:
.. autosummary::
:nosignatures:
~mhkit.mooring.io.read_moordyn
.. automodule:: mhkit.mooring.io
:members:
:undoc-members:
:show-inheritance:
Instead we can replace the short sentence with the automodule which is more detailed.
Also, it is unclear to me when we would use autosummary vs autofunction in the API. Our use seems inconsistent.
We can further reduce duplication of text in our API by replacing all high level descriptions of modules with the
automodulefeature. Modules have varying level of detail and should be kept up to date in the source, which is then propagated to the API.e.g. the
mhkit-python/api.mooring.rstwas previously the following::Instead we can replace the short sentence with the automodule which is more detailed.
Also, it is unclear to me when we would use
autosummaryvsautofunctionin the API. Our use seems inconsistent.