Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[joss] Improve class signatures in documentation #126

Open
IvanIsCoding opened this issue Nov 15, 2023 · 1 comment
Open

[joss] Improve class signatures in documentation #126

IvanIsCoding opened this issue Nov 15, 2023 · 1 comment
Assignees
Labels
active Work in progress enhancement New feature or request joss

Comments

@IvanIsCoding
Copy link

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

@bonicim bonicim added the enhancement New feature or request label Nov 15, 2023
@bonicim
Copy link
Collaborator

bonicim commented Nov 15, 2023

@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.

bonicim added a commit that referenced this issue Nov 15, 2023
Merge in HYP/hypernetx from hotfix/update-modularity-docs to master

* commit '225f584fbcb10ec5fb2ba299b3adffd6c9e05183':
  bump: version 2.1.0 → 2.1.1
  Update modularity docs
@bonicim bonicim added backlog active Work in progress and removed backlog labels Jan 10, 2024
@bonicim bonicim added the joss label Jan 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
active Work in progress enhancement New feature or request joss
Projects
None yet
Development

No branches or pull requests

3 participants