pnnl/HyperNetX

[joss] Improve class signatures in documentation

IvanIsCoding opened this issue · 1 comments

Is your feature request related to a problem? Please describe.

Currently, class signatures in the documentation are hard to read due to type annotations crowding:

Captura de tela de 2023-11-14 22-48-50

In the example above, there are so many type annotations that it is hard to find the second paramater data

Describe the solution you'd like

Because the parameters are already described in the docstring, I belive that hiding the type annotations would lead to a better documentation. Sometimes less is more. The parameters for the class constructors should be obvious.

Additional context

openjournals/joss-reviews#6016, I do not consider this issue blocking for acceptance. But it would be a good improvement

@IvanIsCoding Thanks for your feedback. We are currently overhauling our documentation to be more user-friendly and will address your comments regarding how the type annotations are obscuring the constructor and parameters.