NOTE: I am filing this issue on behalf of a user who asked about wfdb in the #python channel on the Libera.chat IRC network.
The wfdb HTML documentation does not distinguish between parameters and return values, with a fairly confusing presentation to the user who is not aware of this flaw:
It seems that although wfdb uses the numpydoc style of docstrings, these docstrings are not being properly processed by the project's Sphinx configuration.
This is happening because wfdb is not using the numpydoc Sphinx extension. Installing a compatible version (numpydoc<1.6 is required by wfdb's current Sphinx version) and adding it to the extension list in conf.py produces a much more legible rendering. See #472.
NOTE: I am filing this issue on behalf of a user who asked about
wfdb
in the #python channel on the Libera.chat IRC network.The
wfdb
HTML documentation does not distinguish between parameters and return values, with a fairly confusing presentation to the user who is not aware of this flaw:It seems that although
wfdb
uses thenumpydoc
style of docstrings, these docstrings are not being properly processed by the project's Sphinx configuration.This is happening because
wfdb
is not using thenumpydoc
Sphinx extension. Installing a compatible version (numpydoc<1.6
is required bywfdb
's current Sphinx version) and adding it to the extension list inconf.py
produces a much more legible rendering. See #472.