[joss] Random hypergraph generators need more detailed documentation
szhorvat opened this issue · 0 comments
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.