Eden-Kramer-Lab / spectral_connectivity

Frequency domain estimation and functional and directed connectivity analysis tools for electrophysiological data
GNU General Public License v3.0
121 stars 43 forks source link

Docs error for multiple-line array shapes #47

Closed emilyps14 closed 1 year ago

emilyps14 commented 1 year ago

If the type is split across multiple lines in the docstring, the docs only pull out the first line for the "Type" section

See e.g. The fourier_coefficients parameter of the Connectivity constructor: https://spectral-connectivity.readthedocs.io/en/latest/source/spectral_connectivity.html#spectral_connectivity.connectivity.Connectivity.expectation_type

Screen Shot 2022-11-02 at 9 55 17 AM Screen Shot 2022-11-02 at 9 56 29 AM
edeno commented 1 year ago

Should be fixed in the documentation.