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
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:
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
The text was updated successfully, but these errors were encountered:
@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.
Merge in HYP/hypernetx from hotfix/update-modularity-docs to master
* commit '225f584fbcb10ec5fb2ba299b3adffd6c9e05183':
bump: version 2.1.0 → 2.1.1
Update modularity docs
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:
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
The text was updated successfully, but these errors were encountered: