[joss] Random hypergraph generators need more detailed documentation #141
Comments
bonicim
added a commit
that referenced
this issue
Mar 1, 2024
Merge in HYP/hypernetx from release/v2.2.0 to master * commit '02b19d03a731ff1b81871cc96ea650766aa207ce': (76 commits) bump: version 2.1.4 → 2.2.0 Update docs on installation, widget; update Readme and Makefile Update optional dependencies; cleanup Makefile Fix tests Update installation instructions for widget Add images Move incidence visualization to tutorial 2 Fix function call to updated draw function Run linter Use HNX for ingesting incidence matrix. Also uses HNX to store/access cell weights. Modification of draw function to support drawing the star hypergraph HYP-365 Silence warnings in tutorials Run linter removed readded test module updated empty hypergraph to have dataframes for properties HYP-360 Improve code quality tooling; update Makefile Remove unnecessary dependencies for documentation Update nb2plots Fix github workflow for documentation Update tests for soon to be deprecated translate methods ...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
The random hypergraph generators are very sparsely documented at the moment. The documentation only contains links to papers (and the name of the implementor) but it does not explain what these functions actually do. I feel that in most of these cases it would be possible to provide a precise explanation of the generation procedure within a short paragraph.
The same applies to some other functionality areas as well, such as
algorithms.contagion. The question is: how much expertise should a user have to be able to start using these functions and understand their documentation? Naturally, some familiarity should be expected, but I feel that here even an expert would be left with questions about some of the details of the algorithms.Ref: openjournals/joss-reviews#6016
The text was updated successfully, but these errors were encountered: